latestOpenAPI 3.1.02026-08-228421843.5 KB

6ad6c02e6af9

Activities

List activities

Lists all system-defined and user-defined activities in your workspace.

This endpoint is in alpha and may be subject to breaking changes as we gather feedback.

Required scopes: activity_configuration:read.

get/v2/activities

Query parameters

limitinteger

The maximum number of activities to return. Must be between 1 and 1000. Defaults to 100.

Example:100

cursorstring

A pagination cursor used to fetch the next page of activities. Responses with more activities will include a cursor for you to use here. If not provided, the first page will be returned.

Example:eyJkZXNjcmlwdGlvbiI6ICJ0aGlzIGlzIGEgY3Vyc29yIn0=.eM56CGbqZ6G1NHiJchTIkH4vKDr

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "activity_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
      },
      "api_slug": "phone_calls",
      "singular_noun": "Phone call",
      "plural_noun": "Phone calls",
      "extends": [
        {
          "schema_id": "b1d6a29e-6f6f-4a0a-9b0e-59f0a3e3f7a1",
          "schema_slug": "calls"
        }
      ],
      "is_system_activity": true,
      "created_at": "2022-11-21T13:22:49.061281000Z"
    }
  ]
}