Back to Content Management API

schedules

Returns a list of schedules paginated by a cursor.

Arguments

  • Name
    after
    Type
    String
    Description

    Returns the elements that come after the specified cursor.

  • Name
    before
    Type
    String
    Description

    Returns the elements that come before the specified cursor.

  • Name
    first
    Type
    Int
    Description

    Returns up to the first n elements from the list.

  • Name
    last
    Type
    Int
    Description

    Returns up to the last n elements from the list.

Returns

  • Name
    SectionConnection.edges
    Type
    [ScheduleEdge!]!
    Description

    A list of edges.

  • Name
    SectionConnection.nodes
    Type
    [Schedule!]!
    Description

    A list of the nodes contained in ScheduleEdge.

  • Name
    SectionConnection.pageInfo
    Type
    PageInfo!
    Description

    Information to aid in pagination.

  • Name
    SectionConnection.totalCount
    Type
    Int
    Description

    The total count of items.

Request

POST
/graphql
import ApiClient from '@example/protocol-api'

const client = new ApiClient(token)

await client.contacts.list()

Response

{
  "has_more": false,
  "data": [
    {
      "id": "WAz8eIbvDR60rouK",
      "username": "FrankMcCallister",
      "phone_number": "1-800-759-3000",
      "avatar_url": "https://assets.protocol.chat/avatars/frank.jpg",
      "display_name": null,
      "conversation_id": "xgQQXg3hrtjh7AvZ",
      "last_active_at": 705103200,
      "created_at": 692233200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

Was this page helpful?