Status Queries

Get a Status

status returns the requested status or null when no matching status exists.

query GetStatus(
  $id: String!
  $postCursor: String
  $postLimit: Int
) {
  status(id: $id) {
    id
    color
    name
    type
    posts(cursor: $postCursor, limit: $postLimit) {
      nodes {
        id
        title
      }
      hasMore
      cursor
    }
  }
}

Argument	Type	Description
id	String!	ID of the status to retrieve
postCursor	String	Cursor returned by the previous page of status posts
postLimit	Int	Number of status posts to return

Reading Status.posts requires ssotype and ssoid request headers.

List Board Statuses

The API key scopes this query to one board.

query ListStatuses {
  listStatuses {
    id
    name
    color
    type
  }
}

listStatuses returns [Status!]!.

Status Type

Field	Type	Description
id	String!	Status ID
color	String!	Status display color
name	String!	Status name
type	StatusType!	System or custom status type
posts	StatusPostsPayload!	Paginated posts linked to the status

StatusType can be CUSTOM, ARCHIVED, COMPLETED, MERGED, or UNASSIGNED.

StatusPostsPayload contains nodes: [Post]!, hasMore: Boolean!, and cursor: String.