Skip to content
API Reference/
/
Get All Persons

Get All Persons

Request

Get all persons the current API user can manage.
To specify products with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 URL param

Security
X-API-KEY or Authorization
curl -i -X GET \
  https://uberall.com/api/persons \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved persons

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,
    "total": 100,
    "persons": [
      {
        "title": "string",
        "description": "string",
        "identifier": "string",
        "listName": "string",
        "id": 0,
        "name": "string",
        "image": {
          "id": 0,
          "url": "string",
          "type": "LOGO",
          "description": "string",
          "uid": "string"
        },
        "url": "string"
      }
    ]
  }
}