Skip to content
API Reference/
/
Get a Collection

Get a Collection

Request

Retrieve a specific Collection by id

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the Collection to retrieve

curl -i -X GET \
  'https://uberall.com/api/collections/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Collection found

Bodyapplication/json
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": {
    "collection": { … }
  }
}