Skip to content
/Labels

Labels

Locations Hub - Labels

Operations

Get all labels

Request

Get all labels associated to the locations of the user

Security
X-API-KEY or Authorization
Query
querystring

Used for searching for a specific keyword within label names, only label names matching the given query via 'like' will be returned.

curl -i -X GET \
  'https://uberall.com/api/labels/list?query=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved labels

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 10,
    "count": 100,
    "labels": [
      {
        "name": "string",
        "adminOnly": true
      }
    ]
  }
}