Skip to main content

List Labels

GET 

https://secure.fleetio.com/api/labels

Returns a list of Labels belonging to your account.

Request

Query Parameters

    start_cursor string

    The start cursor for Keyset pagination.

    per_page integer

    Possible values: >= 2 and <= 100

    The number of records per page to return.

    Default value: 50
    filter object

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

    name object
    oneOf
    likestringrequired
    sort object

    The fields and direction to sort the results by.

    idSortAscDescDefaultDesc (string)

    Possible values: [asc, desc]

    Default value: desc

Responses

OK

Schema
    start_cursorstringnullable

    The current start cursor of the records returned.

    next_cursorstringnullable

    The next cursor to retrieve the next page of records.

    per_pageinteger

    The maxumum number of records returned.

    estimated_remaining_countinteger

    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.

  • Array [
  • anyOf
    name object
    oneOf
    likestringrequired
  • ]
  • sorted_by object[]

    The sorts applied to the returned record set.

  • Array [
  • anyOf
    idSortAscDesc (string)

    Possible values: [asc, desc]

  • ]
  • records object[]
  • Array [
  • idId (integer)required

    Possible values: >= 1

    account_idId (integer)required

    Possible values: >= 1

    namestringrequired

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

    taggings_countintegerrequired

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

    colorstringrequired

    The hex color of the Label.

    Example: #E97451
  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
curl -L 'https://secure.fleetio.com/api/labels' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— query
— query
— query
name
— query
id
ResponseClear

Click the Send API Request button above and see the response here!