SequenceStates

List sequence states

Returns a paginated list of sequence states (enrollments). Supports filtering by sequence, prospect, account, and state.

filter[account][id] joins through the prospect.

get/sequenceStates

Request

Base URL: https://partner-api.nooks.in/v1
URL: https://partner-api.nooks.in/v1/sequenceStates
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: sequence-states:read)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[sequence][id]string uuid

Filter by sequence ID

filter[prospect][id]string uuid

Filter by prospect ID

filter[account][id]string uuid

Filter by account ID (matches the prospect's account).

filter[state]string[]

Filter by state (comma-separated). Valid values: active, paused, finished, pending_start

includestring[]

Comma-separated relations to expand inline. Valid values: sequence, prospect, creator, sequenceStep. Max 3.

filter[updatedAt][gte]string date-time

Filter by minimum updatedAt (ISO 8601 datetime)

filter[updatedAt][lt]string date-time

Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)

Response

Successful response

Example response

{
  "data": [
    {
      "id": "880e8400-e29b-41d4-a716-446655440010",
      "state": "active",
      "sequence": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "prospect": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "account": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "creator": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "owner": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "sequenceStep": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "createdAt": "2025-11-01T10:00:00.000Z",
      "updatedAt": "2025-11-05T14:30:00.000Z"
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.