BObookingexperts
Executors

GET executors

Changed on

Returns executors of the administration

get/v3/administrations/{administration_id}/executors

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[executor]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[user]string

Filter on user. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

ExecutorCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "executor",
      "attributes": {
        "locale": "cs"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "user"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "user",
      "attributes": {
        "locale": "nl"
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /// response property for the response status

    • warning

      added the new en-GB enum value to the /// response property for the response status

    • warning

      added the new en-US enum value to the /// response property for the response status