Skip to main content

BoardsResponse

Response containing board data

boards object

Board connection wrapper with pagination

boards object[]

List of board records

  • Array [
  • codestring

    Board code identifier

    boardData object

    Board data details

    codestring

    Board code

    boardCodestring

    Provider-specific board code

  • ]
  • countinteger

    Total number of boards matching the query

    tokenstring

    Pagination token for the next page of results. To retrieve the next page, include this token in the 'token' field of the subsequent request. Tokens are valid for 4 minutes and are tied to the original query criteria. If the query criteria change, a new token must be generated.

    errors object[]

    Array of errors encountered during processing

  • Array [
  • codestring

    Error code identifier

    typestring

    Error type category

    Possible values: [CLIENT, SERVER]

    descriptionstring

    Human-readable error description

  • ]
  • BoardsResponse
    {
    "boards": {
    "boards": [
    {
    "code": "string",
    "boardData": {
    "code": "string",
    "boardCode": "string"
    }
    }
    ],
    "count": 0,
    "token": "string"
    },
    "errors": [
    {
    "code": "string",
    "type": "CLIENT",
    "description": "string"
    }
    ]
    }