ROrossum
Label

List labels

Changed on

List all label objects.

get/api/v1/labels

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

namestring

Object name filter

ordering'id' | '-id' | 'name' | '-name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1,
      "url": "https://example.rossum.app/api/v1/labels/1",
      "name": "expedite",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "color": "#FF5733"
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status