Get team audit logs

GET

/audit/logs

GET

/audit/logs

$ curl https://api.getpostman.com/audit/logs \
>      -H "x-api-key: <apiKey>"

1 {
2   "trails": [
3     {
4       "id": 12345678,
5       "ip": "192.0.2.0",
6       "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
7       "action": "user.login_google_success",
8       "timestamp": "2022-08-31T15:19:32.000Z",
9       "message": "Taylor Lee successfully logged in using the Google OAuth.",
10       "data": {
11         "actor": {
12           "name": "Taylor Lee",
13           "username": "taylor-lee",
14           "email": "taylor.lee@example.com",
15           "id": 12345678,
16           "active": true
17         },
18         "user": {
19           "name": "Taylor Lee",
20           "username": "taylor-lee",
21           "email": "taylor.lee@example.com",
22           "id": 12345678
23         },
24         "team": {
25           "name": "Test-Team",
26           "id": 1234
27         }
28       }
29     },
30     {
31       "id": 87654321,
32       "ip": "192.0.2.1",
33       "userAgent": "PostmanRuntime/7.29.0 Postman/5.5.4 ChromeApp",
34       "action": "user.login_password_success",
35       "timestamp": "2022-09-01T06:30:21.000Z",
36       "message": "Alex Cruz successfully logged in using the Postman password.",
37       "data": {
38         "actor": {
39           "name": "Alex Cruz",
40           "username": "alex-cruz",
41           "email": "alex.cruz@example.com",
42           "id": 87654321,
43           "active": true
44         },
45         "user": {
46           "name": "Alex Cruz",
47           "username": "alex-cruz",
48           "email": "alex.cruz@example.com",
49           "id": 87654321
50         },
51         "team": {
52           "name": "Test-Team",
53           "id": 1234
54         }
55       }
56     }
57   ]
58 }

Gets a list of your team’s generated audit events. For a complete list of all audit events, see Audit logs.

Gets a list of your team's generated audit events. For a complete list of all audit events, see [Audit logs](https://learning.postman.com/docs/administration/audit-logs/).

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

userIdintegerOptional

Return only results that match the given user ID.

actionstringOptional

Filter results by an audit log action.

sincedateOptional

Return logs created after the given time, in YYYY-MM-DD format.

untildateOptional

Return logs created before the given time, in YYYY-MM-DD format.

limitintegerOptional<=300

The maximum number of audit events to return at once.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

orderByenumOptionalDefaults to desc

Return the records in ascending (asc) or descending (desc) order.

Allowed values:

order_byenumOptionalDefaults to descDeprecated

Return the records in ascending (asc) or descending (desc) order.

Allowed values:

Response

Successful Response

trailslist of objects

A list of audit log events.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error