List User Labels

GET 
/labels/users/

Request

Query Parameters

length integerrequired

Number of results to return per page.

ordering stringrequired

Which field to use when ordering the results.

page integerrequired

A page number within the paginated result set.

search stringrequired

A search term.

Responses

200

application/json

Schema

Schema

count integerrequired

Total number of results.

page_total integerrequired

Total number of pages.

page integerrequired

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integerrequired

Number of results returned per page.

results object[]
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$
Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-09-18T08:50:22.026Z"
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...