Todo TodoImages

GET todo_images

List all todo images

get/v3/administrations/{administration_id}/todos/{todo_id}/todo_images

Request

Path parameters

todo_idstring required

Todo ID

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, created_at

fields[todo_image]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[created_at]string

Filter on created_at

filter[todo]string

Filter on todo. 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

TodoImageCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "todo_image",
      "relationships": {
        "todo": {
          "data": {
            "type": "todo"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "todo",
      "relationships": {
        "executor": {
          "data": {
            "type": "executor"
          }
        },
        "facility": {
          "data": {
            "type": "facility"
          }
        },
        "rentable_identity": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "todo_list": {
          "data": {
            "type": "todo_list"
          }
        },
        "reservation": {
          "data": {
            "type": "reservation"
          }
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "creator": {
          "data": {
            "type": "user"
          }
        },
        "invoice": {
          "data": {
            "type": "invoice"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.