List Labels

Returns a list of Labels belonging to your account.

Query Parameters

• start_cursor string

  The start cursor for Keyset pagination.

• per_page integer

  Possible values: >= 2 and <= 100

  Default value: 50

  The number of records per page to return.

• filter object

  The fields, operations, and values to filter the records by.

  • name object

    oneOf

    • MOD1
    • MOD2

    ---

    like string required

    eq string required
• sort object

  The fields and direction to sort the results by.

  • id string

    Possible values: [asc, desc]

    Default value: desc

Responses

• 200
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• start_cursor string

  The current start cursor of the records returned.

• next_cursor string

  The next cursor to retrieve the next page of records.

• per_page integer

  The maxumum number of records returned.

• estimated_remaining_count integer

  The number of remaining records including the returned records, up to a maximum of 500.

• filtered_by object[]

  The filters applied to the returned record set.

  anyOf

  • MOD1

  ---

  name object

  oneOf

  • MOD1
  • MOD2

  ---

  like string

  eq string
• sorted_by object[]

  The sorts applied to the returned record set.

  anyOf

  • MOD1

  ---

  id string

  Possible values: [asc, desc]

• records object[]

  id integer

  Possible values: >= 1

  account_id integer

  Possible values: >= 1

  name string

  The name of the Label. This is the value used to tag a record.

  taggings_count integer

  The number of records that have been tagged with this Label.

  color string

  The hex color of the Label.

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "account_id": 0,
      "name": "string",
      "taggings_count": 0,
      "color": "#E97451"
    }
  ]
}

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Loading...