List schema activities

Returns the history of schema changes for an object type as a paginated list of activities. Each activity groups the change events for one modification, such as adding or editing a field.

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

entity*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

Query Parameters

page?

Offset pagination, e.g. page[offset]=0&page[limit]=100.

sortOrder?

Sort order, e.g. sortOrder[column]=_created_at&sortOrder[dir]=DESC.

Response Body

`application/json`

curl -X GET "https://example.com/workspaces/string/schemas/string/activities"

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "total_records": 1,
    "total_pages": 1,
    "offset": 0,
    "limit": 500
  },
  "data": [
    {
      "id": "c3d4e5f6-a7b8-4c9d-8e0f-2a3b4c5d6e7f",
      "type": "activity",
      "attributes": {
        "_id": "c3d4e5f6-a7b8-4c9d-8e0f-2a3b4c5d6e7f",
        "_created_at": "2026-02-01T17:45:00.000Z",
        "aggKey": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e:clarify:update",
        "data": [
          {
            "_id": "c3d4e5f6-a7b8-4c9d-8e0f-2a3b4c5d6e7f",
            "_created_at": "2026-02-01T17:45:00.000Z",
            "type": "clarify:update",
            "actor": {
              "_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",
              "anonymous_id": null,
              "entity": "user",
              "source_id": null
            },
            "object": {
              "_id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
              "anonymous_id": null,
              "entity": "schema",
              "diff": [
                {
                  "op": "add",
                  "path": [
                    "properties",
                    "budget"
                  ],
                  "val": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "title": "Budget"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}