{
  "info": {
    "_postman_id": "3f90435d-b016-4b92-95d9-904db841e9ea",
    "name": "Audit Records API",
    "description": "This API allows administrators to retrieve audit records in JSON format.\n\nIt retrieves audit records with **create**, **delete** and **update** events on following entities in Platform.\n* Call forwarding rules\n* Call queue\n* Phone Number\n* Extension\n* Ring group\n* User basic information\n* Auto attendant basic information\n\n_**For step-by-step instructions on using the Audit API refer to the [Audit API Summary Guide ](https://docs.google.com/document/d/1rtGbpvCHKtR19fqPYbPh-CA6YTQkeubKgDl6r-b9N4M/edit?usp=sharing)**_.\n\n\nContact Support:\n Email: api@8x8.com",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T00:27:40.000Z",
    "updatedAt": "2026-07-28T00:27:41.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-3f90435d-b016-4b92-95d9-904db841e9ea"
  },
  "item": [
    {
      "name": "audits",
      "item": [
        {
          "name": "Get audit records.",
          "id": "608ab866-b82f-4290-b31e-14fe2e000753",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json;charset=UTF-8"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/audits?size=<integer>&startTime=<string>&endTime=<string>&service=<string>&displayName=<string>&auditUserId=<string>&entityTypes=<string>&eventTypes=view&scrollId=<string>",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "audits"
              ],
              "query": [
                {
                  "description": "Maximum number of items per page. It must be greater than zero. Default value is 20, maximum is 100.",
                  "key": "size",
                  "value": "<integer>"
                },
                {
                  "description": "(Required) Start time for audit records (ISO 8601 format), it should be maximum of 31 days before end time.",
                  "key": "startTime",
                  "value": "<string>"
                },
                {
                  "description": "(Required) End time of audit records (ISO 8601 format).",
                  "key": "endTime",
                  "value": "<string>"
                },
                {
                  "description": "(Required) Name of a service that generated audit records.",
                  "key": "service",
                  "value": "<string>"
                },
                {
                  "description": "Name linked with entity i.e, if an entity is user it's userName, if an entity is RingGroup it is a ring group name.",
                  "key": "displayName",
                  "value": "<string>"
                },
                {
                  "description": "The identifier for user who performed audit action.",
                  "key": "auditUserId",
                  "value": "<string>"
                },
                {
                  "description": "Comma-separated strings of entity types.",
                  "key": "entityTypes",
                  "value": "<string>"
                },
                {
                  "description": "Comma-separated strings of event types.",
                  "key": "eventTypes",
                  "value": "view"
                },
                {
                  "description": "The scrollId parameter returned from your previous call. You can include this parameter in your next or subsequent calls to retrieve the next page of records. To retrieve first page no need to provide scrollId.",
                  "key": "scrollId",
                  "value": "<string>"
                }
              ]
            },
            "description": "Retrieve audit records in JSON format"
          },
          "response": [
            {
              "id": "f3e5adb9-89ce-4b67-a741-eb7ac50b6059",
              "name": "successful operation",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json;charset=UTF-8"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "x-api-key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/audits?size=<integer>&startTime=<string>&endTime=<string>&service=<string>&displayName=<string>&auditUserId=<string>&entityTypes=<string>&eventTypes=view&scrollId=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "audits"
                  ],
                  "query": [
                    {
                      "description": "Maximum number of items per page. It must be greater than zero. Default value is 20, maximum is 100.",
                      "key": "size",
                      "value": "<integer>"
                    },
                    {
                      "description": "(Required) Start time for audit records (ISO 8601 format), it should be maximum of 31 days before end time.",
                      "key": "startTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) End time of audit records (ISO 8601 format).",
                      "key": "endTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) Name of a service that generated audit records.",
                      "key": "service",
                      "value": "<string>"
                    },
                    {
                      "description": "Name linked with entity i.e, if an entity is user it's userName, if an entity is RingGroup it is a ring group name.",
                      "key": "displayName",
                      "value": "<string>"
                    },
                    {
                      "description": "The identifier for user who performed audit action.",
                      "key": "auditUserId",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of entity types.",
                      "key": "entityTypes",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of event types.",
                      "key": "eventTypes",
                      "value": "view"
                    },
                    {
                      "description": "The scrollId parameter returned from your previous call. You can include this parameter in your next or subsequent calls to retrieve the next page of records. To retrieve first page no need to provide scrollId.",
                      "key": "scrollId",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "OK",
              "code": 200,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json;charset=UTF-8"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"meta\": {\n    \"totalRecordCount\": 0,\n    \"scrollId\": \"<string>\"\n  },\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"service\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"auditTimestamp\": \"<dateTime>\",\n      \"eventType\": \"<string>\",\n      \"correlationType\": \"<string>\",\n      \"correlationId\": \"<string>\",\n      \"entityType\": \"<string>\",\n      \"entityKey\": \"<string>\",\n      \"auditUserId\": \"<string>\",\n      \"impersonator\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"service\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"auditTimestamp\": \"<dateTime>\",\n      \"eventType\": \"<string>\",\n      \"correlationType\": \"<string>\",\n      \"correlationId\": \"<string>\",\n      \"entityType\": \"<string>\",\n      \"entityKey\": \"<string>\",\n      \"auditUserId\": \"<string>\",\n      \"impersonator\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}",
              "createdAt": "2026-07-28T00:27:40.000Z",
              "updatedAt": "2026-07-28T00:27:40.000Z",
              "uid": "35240-f3e5adb9-89ce-4b67-a741-eb7ac50b6059"
            },
            {
              "id": "68d881c0-a77d-41bc-96b3-4e95ca7bdf04",
              "name": "Bad request",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json;charset=UTF-8"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "x-api-key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/audits?size=<integer>&startTime=<string>&endTime=<string>&service=<string>&displayName=<string>&auditUserId=<string>&entityTypes=<string>&eventTypes=view&scrollId=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "audits"
                  ],
                  "query": [
                    {
                      "description": "Maximum number of items per page. It must be greater than zero. Default value is 20, maximum is 100.",
                      "key": "size",
                      "value": "<integer>"
                    },
                    {
                      "description": "(Required) Start time for audit records (ISO 8601 format), it should be maximum of 31 days before end time.",
                      "key": "startTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) End time of audit records (ISO 8601 format).",
                      "key": "endTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) Name of a service that generated audit records.",
                      "key": "service",
                      "value": "<string>"
                    },
                    {
                      "description": "Name linked with entity i.e, if an entity is user it's userName, if an entity is RingGroup it is a ring group name.",
                      "key": "displayName",
                      "value": "<string>"
                    },
                    {
                      "description": "The identifier for user who performed audit action.",
                      "key": "auditUserId",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of entity types.",
                      "key": "entityTypes",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of event types.",
                      "key": "eventTypes",
                      "value": "view"
                    },
                    {
                      "description": "The scrollId parameter returned from your previous call. You can include this parameter in your next or subsequent calls to retrieve the next page of records. To retrieve first page no need to provide scrollId.",
                      "key": "scrollId",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "Bad Request",
              "code": 400,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json;charset=UTF-8"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"timestamp\": \"<dateTime>\",\n  \"status\": \"<integer>\",\n  \"error\": \"<string>\",\n  \"message\": \"<string>\",\n  \"path\": \"<string>\"\n}",
              "createdAt": "2026-07-28T00:27:40.000Z",
              "updatedAt": "2026-07-28T00:27:40.000Z",
              "uid": "35240-68d881c0-a77d-41bc-96b3-4e95ca7bdf04"
            },
            {
              "id": "2176a4ca-6795-41f5-b9eb-8082059b56c6",
              "name": "Unauthorized",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json;charset=UTF-8"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "x-api-key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/audits?size=<integer>&startTime=<string>&endTime=<string>&service=<string>&displayName=<string>&auditUserId=<string>&entityTypes=<string>&eventTypes=view&scrollId=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "audits"
                  ],
                  "query": [
                    {
                      "description": "Maximum number of items per page. It must be greater than zero. Default value is 20, maximum is 100.",
                      "key": "size",
                      "value": "<integer>"
                    },
                    {
                      "description": "(Required) Start time for audit records (ISO 8601 format), it should be maximum of 31 days before end time.",
                      "key": "startTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) End time of audit records (ISO 8601 format).",
                      "key": "endTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) Name of a service that generated audit records.",
                      "key": "service",
                      "value": "<string>"
                    },
                    {
                      "description": "Name linked with entity i.e, if an entity is user it's userName, if an entity is RingGroup it is a ring group name.",
                      "key": "displayName",
                      "value": "<string>"
                    },
                    {
                      "description": "The identifier for user who performed audit action.",
                      "key": "auditUserId",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of entity types.",
                      "key": "entityTypes",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of event types.",
                      "key": "eventTypes",
                      "value": "view"
                    },
                    {
                      "description": "The scrollId parameter returned from your previous call. You can include this parameter in your next or subsequent calls to retrieve the next page of records. To retrieve first page no need to provide scrollId.",
                      "key": "scrollId",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json;charset=UTF-8"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"timestamp\": \"<dateTime>\",\n  \"status\": \"<integer>\",\n  \"error\": \"<string>\",\n  \"message\": \"<string>\",\n  \"path\": \"<string>\"\n}",
              "createdAt": "2026-07-28T00:27:40.000Z",
              "updatedAt": "2026-07-28T00:27:40.000Z",
              "uid": "35240-2176a4ca-6795-41f5-b9eb-8082059b56c6"
            },
            {
              "id": "2ee7a411-c5f2-4749-98ce-cbfbc3625a47",
              "name": "Internal Server Error",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "x-api-key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/audits?size=<integer>&startTime=<string>&endTime=<string>&service=<string>&displayName=<string>&auditUserId=<string>&entityTypes=<string>&eventTypes=view&scrollId=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "audits"
                  ],
                  "query": [
                    {
                      "description": "Maximum number of items per page. It must be greater than zero. Default value is 20, maximum is 100.",
                      "key": "size",
                      "value": "<integer>"
                    },
                    {
                      "description": "(Required) Start time for audit records (ISO 8601 format), it should be maximum of 31 days before end time.",
                      "key": "startTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) End time of audit records (ISO 8601 format).",
                      "key": "endTime",
                      "value": "<string>"
                    },
                    {
                      "description": "(Required) Name of a service that generated audit records.",
                      "key": "service",
                      "value": "<string>"
                    },
                    {
                      "description": "Name linked with entity i.e, if an entity is user it's userName, if an entity is RingGroup it is a ring group name.",
                      "key": "displayName",
                      "value": "<string>"
                    },
                    {
                      "description": "The identifier for user who performed audit action.",
                      "key": "auditUserId",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of entity types.",
                      "key": "entityTypes",
                      "value": "<string>"
                    },
                    {
                      "description": "Comma-separated strings of event types.",
                      "key": "eventTypes",
                      "value": "view"
                    },
                    {
                      "description": "The scrollId parameter returned from your previous call. You can include this parameter in your next or subsequent calls to retrieve the next page of records. To retrieve first page no need to provide scrollId.",
                      "key": "scrollId",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "_postman_previewlanguage": "text",
              "header": [],
              "cookie": [],
              "responseTime": null,
              "body": null,
              "createdAt": "2026-07-28T00:27:40.000Z",
              "updatedAt": "2026-07-28T00:27:40.000Z",
              "uid": "35240-2ee7a411-c5f2-4749-98ce-cbfbc3625a47"
            }
          ],
          "createdAt": "2026-07-28T00:27:40.000Z",
          "updatedAt": "2026-07-28T00:27:40.000Z",
          "uid": "35240-608ab866-b82f-4290-b31e-14fe2e000753"
        }
      ],
      "id": "c39d5bbe-8932-47ba-8547-6af1da97ae2e",
      "createdAt": "2026-07-28T00:27:40.000Z",
      "updatedAt": "2026-07-28T00:27:40.000Z",
      "uid": "35240-c39d5bbe-8932-47ba-8547-6af1da97ae2e"
    }
  ],
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "x-api-key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.8x8.com/administration/audit/v1"
    }
  ]
}