Audit Logs

List all Audit Logs

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/audit-logs

List all Audit Logs Returns array of audit logs for given team and filters

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageSizeintegerRequired

pageNumberintegerRequired

startDatestring · dateRequired

endDatestring · dateRequired

action[]string[]Optional

resource[]string[]Optional

actor[]string[]Optional

team[]string[]Optional

Responses

200

The request has succeeded.

application/json

Response model for listing audit logs

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/audit-logs

Python (SDK)Typescript (SDK)

from datetime import date
from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.audit_logs.list(page_size=832442, page_number=555332, start_date=date.fromisoformat("2023-03-04"), end_date=date.fromisoformat("2024-08-07"))

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "id": 1,
      "resource": "text",
      "action": "text",
      "actor": {
        "userID": "text",
        "userName": "text",
        "userEmail": "text",
        "fullName": "text"
      },
      "client": "text",
      "timestamp": "text",
      "team": {
        "id": "text",
        "name": "text",
        "isDeleted": true
      }
    }
  ],
  "metadata": {
    "totalCount": 1
  }
}

Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/audit-logs/export

Export Audit logs Initiates export of audit logs based on provided filters

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request model for exporting audit logs

namestring · min: 1 · max: 100RequiredPattern: ^\S

descriptionstring · max: 300Optional

exportTypestring · enumRequiredPossible values:

Responses

200

The request has succeeded.

application/json

Response model for exporting audit logs

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/audit-logs/export

Python (SDK)Typescript (SDK)

from datetime import date
from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.audit_logs.export(filters={
        "start_date": date.fromisoformat("2025-07-29"),
        "end_date": date.fromisoformat("2023-09-09"),
    }, name="<value>", export_type="json")

    # Handle response
    print(res)

{
  "data": {
    "id": "text",
    "message": "text"
  }
}

List all Audit Logs export history

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/audit-logs/export/history

List all Audit Logs export history Returns array of audit logs export history

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageSizeintegerRequired

pageNumberintegerRequired

Responses

200

The request has succeeded.

application/json

Response model for listing audit logs export history

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/audit-logs/export/history

Python (SDK)Typescript (SDK)

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.audit_logs.list_export_history(page_size=159672, page_number=351281)

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "exportedAt": "text",
      "requestedBy": {
        "userID": "text",
        "userName": "text",
        "userEmail": "text",
        "fullName": "text"
      },
      "downloadLink": "text",
      "status": "text",
      "filters": {
        "startDate": "2026-03-18",
        "endDate": "2026-03-18",
        "resource": [
          "text"
        ],
        "action": [
          "text"
        ],
        "actor": [
          {
            "userID": "text",
            "userName": "text",
            "userEmail": "text",
            "fullName": "text"
          }
        ],
        "team": [
          {
            "id": "text",
            "name": "text",
            "isDeleted": true
          }
        ],
        "client": [
          "text"
        ]
      }
    }
  ],
  "metadata": {
    "totalCount": 1
  }
}

Get details of Audit Logs export history by ID

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/audit-logs/export/history/{id}

Get details of Audit Logs export history by ID Returns audit log export history details for the specified ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

The request has succeeded.

application/json

Response model for getting audit log export history by ID

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/audit-logs/export/history/{id}

Python (SDK)Typescript (SDK)

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.audit_logs.get_export_history_by_id(id="<id>")

    # Handle response
    print(res)

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "exportedAt": "text",
    "requestedBy": {
      "userID": "text",
      "userName": "text",
      "userEmail": "text",
      "fullName": "text"
    },
    "downloadLink": "text",
    "status": "text",
    "filters": {
      "startDate": "2026-03-18",
      "endDate": "2026-03-18",
      "resource": [
        "text"
      ],
      "action": [
        "text"
      ],
      "actor": [
        {
          "userID": "text",
          "userName": "text",
          "userEmail": "text",
          "fullName": "text"
        }
      ],
      "team": [
        {
          "id": "text",
          "name": "text",
          "isDeleted": true
        }
      ],
      "client": [
        "text"
      ]
    }
  }
}

Get audit log by ID

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/audit-logs/{id}

Get audit log by ID Returns audit log details for the specified ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

The request has succeeded.

application/json

Response model for getting audit log by ID

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/audit-logs/{id}

Python (SDK)Typescript (SDK)

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.audit_logs.get_by_id(id="<id>")

    # Handle response
    print(res)

{
  "data": {
    "id": 1,
    "resource": "text",
    "action": "text",
    "actor": {
      "userID": "text",
      "userName": "text",
      "userEmail": "text",
      "fullName": "text"
    },
    "client": "text",
    "timestamp": "text",
    "timezone": "text",
    "team": {
      "id": "text",
      "name": "text",
      "isDeleted": true
    },
    "tokenType": "text",
    "ipAddress": "text",
    "additionalInfo": "text",
    "meta": {},
    "userAgent": "text"
  }
}