Labels

Get labels paginated

Fetch labels paginated

get/api/v4/labels

Request

  • Base URL
    https://cabify-sandbox.com
  • URL
    https://cabify-sandbox.com/api/v4/labels
  • Auth
    HTTP bearer

Query parameters

perinteger

Amount of labels for page

pageinteger

Number of page to fetch

activeboolean

Filter by active Labels. If not set then all Labels are returned

Response

Success

pageinteger

Current page.

pagesinteger

Number of pages fetched.

perinteger

Amount of labels per page.

totalinteger

total of results.

Example response

{
  "data": [
    {
      "active": true,
      "client_id": "5ad782201d2e111dba689aa86d149702",
      "description": "Cabify label example",
      "id": "9a0e2da7-f93a-4b24-bce4-7a8b10d3997a",
      "name": " Name of the Label",
      "slug": "name-of-the-label"
    }
  ],
  "page": 1,
  "pages": 1,
  "per": 20,
  "total": 3
}

Changes

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