Messages

List activities

Changed on

Returns a paginated list of activities for the specified message.

get/v1/messages/{message_id}/activities

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/messages/{message_id}/activities
  • Auth: HTTP bearer

Path parameters

message_idstring required

The ID of the message to fetch activities for.

Query parameters

trigger_datastring

The trigger data to filter activities by.

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

Response

OK

Example response

{
  "items": [
    {
      "__typename": "Activity",
      "actor": null,
      "data": {
        "foo": "bar"
      },
      "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
      "inserted_at": "2024-01-01T00:00:00Z",
      "recipient": {
        "__typename": "User",
        "avatar": null,
        "created_at": null,
        "email": "jane@ingen.net",
        "id": "jane",
        "name": "Jane Doe",
        "phone_number": null,
        "timezone": null,
        "updated_at": "2024-05-22T12:00:00Z"
      },
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

  • 46f457b0a700Revision changes
    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

  • 923618cb1489Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //// to the response with the status