30 days challenge API Documentation

Team Audit Logs

GET https://api.getpostman.com/audit/logs?since={{since}}&until={{until}}&limit={{limit}}&cursor={{cursor}}

The /audit/logs endpoint returns a list of audit events generated for your team. The complete list of all the audit events is available on our [Learning Center] page.

The API response contains an array named trails which contains the details for each audit event such as what was the action, who performed the action, when was it performed, etc.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Body PARAM

Key	Datatype	Required	Description
since	string		Only return audit logs that have been updated after this time. Time is represented using the ISO 8601 date and time format.
until	string		Only return audit logs that have been updated before this time. Time is represented using the ISO 8601 date and time format.
limit	string		The maximum number of results to return.
cursor	string		Provides cursor based pagination.

HEADERS

Key

Datatype

Required

Description

RESPONSES

status OK

{ "trails": [ { "id": 1234567, // A numeric value representing the unique identifier of an audit event. "ip": "12.34.45.67", // The IP address of the actor who performed the action. "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Safari/605.1.15", // A string with the user-agent of the actor. "action": "team.update_user_roles", // A string with an action or event performed by the actor. "timestamp": "2021-12-17T09:05:23.000Z", // The date and time when the action or event was performed. The time is represented using the ISO 8601 date and time format. "message": "Alice updated roles for multiple users.", // A description of the audit event. "data": { "actor": { // An object with information about the actor who performed this action. "name": "Alice", "username": "alice", "id": 734851, "active": true }, "team": { // An object with team information "name": "Alice in Wonderland", "id": 1 }, "variables": { // Additional information on the action performed "users": { "1234": [ "admin", "community-manager", "user", "super-admin" ], "5678": [ "community-manager", "user" ] } } } } ], "nextCursor": 1234567890 // A string that represents the cursor of the next page. }

Curl

curl -X GET 'https://api.getpostman.com/audit/logs?since=undefined&until=undefined&limit=undefined&cursor=undefined?since=undefined&until=undefined&limit=undefined&cursor=undefined'