Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1, maximum length is 36.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 but not more than 100 elements. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 but not more than 100 elements. Minimum length of each is 1.

• slug array[string]

  Slug(s) to be considered for filtering

  At least 1 but not more than 100 elements. Minimum length of each is 1, maximum length of each is 255. Format of each should match the following pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$.

• owner-type array[string]

  Owner type(s) to be considered for filtering

  At least 1 but not more than 100 elements. Values are EMPLOYEE or ENTERPRISE.

• owner-id array[string]

  Owner ID(s) to be considered for filtering

  At least 1 but not more than 100 elements. Minimum length of each is 1.

• persistent boolean

  Filters on persistent contexts. When true only persistent contexts are returned, when false only temporary ones. Omit to return both.

• offset string(positive-integer)

  Default value is 0.

• limit string(positive-integer)

  Format should match the following pattern: ^([1-9]|[1-9][0-9]{1,2}|1000)$. Default value is 25.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • name string | null

      Minimum length is 1, maximum length is 255.

    • slug string | null

      Minimum length is 1, maximum length is 255. Format should match the following pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$.

    • expiresAt string(date-time) | null

      Minimum length is 1.

    • ownerType string Required

      Values are EMPLOYEE or ENTERPRISE.

    • ownerId string | null

      Minimum length is 1.

    • persistent boolean Required
  • meta object Required

    Additional properties are NOT allowed.

    Hide meta attributes Show meta attributes object

    • offset integer Required

      Minimum value is 0. Default value is 0.

    • limit integer Required

      Minimum value is 0. Default value is 25.

    • totalCount integer Required

      Minimum value is 0.