Skip to content
API Reference
/
Users
/
Get All Users

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers

https://uberall.com/api/

Mock Server

https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Provide an access_token for the user

Request

Provides an access_token for the email or the userId provided in the LoginCommand.
The accepted couples are:
[email, password]
[email, private_key]
[userId, private_key]

Bodyapplication/jsonrequired

A LoginCommand object

userIdinteger(int64)

UserId (email or userId is required)

emailstring

User email (email or userId is required)

passwordstring

User Password (password or private_key is required)

private_keystring

Private key (password or private_key is required)

Example: "access_token"
curl -i -X POST \
  https://uberall.com/api/users/login \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": 0,
    "email": "string",
    "password": "string",
    "private_key": "access_token"
  }'

Responses

User successfully authenticated

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

User access_token

response.​access_tokenstring

Access Token

Response
No content

Get All Users

Request

Get all users managed by the current API key

Security
X-API-KEY or Authorization
Query
querystring

Filter by first name, last name or email, e.g. 'tom@gmail.com'

Example: query=tom@gmail.com
maxinteger(int32)

Maximum number of users to display.

offsetinteger(int32)

Offset for pagination.

sortstring

Sorting criteria for result list.

orderstring

Sort the order of the result list asc or desc

locationIdinteger(int64)

Id of a location the users must have administration rights to.

identifierstring

Only return users with this identifier.

curl -i -X GET \
  'https://uberall.com/api/users?query=tom%40gmail.com&max=0&offset=0&sort=string&order=string&locationId=0&identifier=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved list

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​offsetinteger(int32)

The offset for pagination

Example: 0
response.​maxinteger(int32)

The maximum number of results to return

Example: 10
response.​countinteger(int32)

The total count of users

Example: 100
response.​usersArray of objects(User)
Response
No content

Create a User

Request

Create a new user, subject to throttling of 10 creations per 10 seconds.

Security
X-API-KEY or Authorization
Bodyapplication/json

User data to be created

emailstringrequired

Email

passwordstring

The user's password. Only for POST requests. Don't use when creating a user with status INVITED!

idinteger(int64)

The uberall unique id for the user

salutationstring

One of MALE, FEMALE or OTHER

firstnamestringrequired

First Name

lastnamestringrequired

Last name

phonestring

The user's phone number

statusstring

The status of the current user. One of CREATED, VERIFIED, UNVERIFIED, INVITED, INACTIVE, NO_LOGIN

Enum"INVITED""CREATED""VERIFIED""UNVERIFIED""INACTIVE""DELETED""NO_LOGIN"
rolestringrequired

User Role

Enum"UBER_API_ADMIN""API_ADMIN""ADMIN""ACCOUNT_MANAGER""BUSINESS_MANAGER""LOCATION_MANAGER""BUSINESS_MANAGER_INBOX"
salesPartnerobject

The "Sales Partner" this user belongs to

preferredLanguagestring

Preferred language of a user. If not set, this will default to the language in context, e.g., location's for e-mails and browser language for our applications.

identifierstring

The unique user identifier based on your internal identification system

featuresArray of stringsunique

A list of features this user can work with. Values:

ADS_READ
ADS_WRITE
ADVANCED_ANALYTICS
AI_SUGGESTED_REPLIES
AI_BULK_REPLIES 
APPLE_POSTING_WRITE
AUTO_RESPONSE_WRITE
BULK_UPDATES
BUSINESS_LEVEL_CONNECT
CAN_PAY_INVOICE
CAN_SEE_HELP_SECTION
CHAT_READ
CHAT_WRITE
CHATBOT_READ
CHATBOT_WRITE
DAM
ENTERPRISE_ONBOARDING
FIRST_PARTY_REVIEW_APPROVAL
FORMS
INBOX_2_0_BETA_READ
INBOX_2_0_BETA_WRITE
INBOX_APPROVAL
INBOX_READ
INBOX_WRITE
INSTAGRAM_POSTING_WRITE
LISTINGS_PAGE_NEW
LISTINGS
LIVE_CHAT
LOCATION_GROUP
LOCATION_READ
LOCATION_SCHEDULED_UPDATES
LOCATION_STATUS_CHANGE
LOCATION_WRITE
POSTING_APPROVAL
POSTING_READ
POSTING_WRITE
PRICE_INFO
RESPONSE_LIBRARY_READ
RESPONSE_LIBRARY_WRITE
REVIEW_GENERATION_CREATE
REVIEW_GENERATION_SEND
SINGLE_SIGN_ON
SOCIAL_ADS
SUPPRESSION
TRACKING
UPGRADE
USER_OTHERS_EDIT
USER_SELF_EDIT
Items Enum"NEW_PHOTO_TYPES""ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING"
emailSettingsArray of objects(EmailSettings)unique

A list of EmailSettings for this user. Only one EmailSettings object per EmailType possible.

featuresDetailedobject

Map containing the feature names and corresponding feature-specific parameters. "featuresDetailed" is supported for the features LOCATION_WRITE and ADVANCED_ANALYTICS. For LOCATION_WRITE a list of fields that this user can update is expected. For ADVANCED_ANALYTICS a list of dashboards the user has access to is expected. For example:


"featuresDetailed": '{'
'{'
   "featuresDetailed":'{'
      "LOCATION_WRITE":[
         "fax",
         "openingHours",
         "callTrackingNumbers",
         "streetNo",
         "openingHoursNotes",
         "specialOpeningHours",
         "street",
         "languages",
         "customFields",
         "contentLists",
         "photos",
         "services",
         "moreHours",
         "descriptionLong",
         "zip",
         "lat",
         "openingDate",
         "email",
         "addressDisplay",
         "labels",
         "taxNumber",
         "city",
         "cellphone",
         "contentCollections",
         "attributes",
         "categories",
         "imprint",
         "phone",
         "utms",
         "addressExtra",
         "keywords",
         "legalIdent",
         "lng",
         "paymentOptions",
         "descriptionShort",
         "socialProfiles",
         "identifier",
         "website",
         "country",
         "province",
         "name",
         "videos",
         "brands",
         "serviceAreas"
      ],
      "ADVANCED_ANALYTICS":[
         "overview",
         "listings-google",
         "customer-feedback"
      ]
   '}'
'}'
whitelabelInformationobject

Whitelabel Information Model

rolesArray of strings

The user's role. One of ADMIN, BUSINESS_MANAGER, MULTI_BUSINESS_MANAGER, LOCATION_MANAGER.

Items Enum"UBER_API_ADMIN""API_ADMIN""ADMIN""ACCOUNT_MANAGER""BUSINESS_MANAGER""LOCATION_MANAGER""BUSINESS_MANAGER_INBOX"
locationGroupIdsArray of integers(int64)

A list of all location group IDs the user is assigned to.

managedLocationsViaGroupsArray of integers(int64)

A list of all location IDs the user can manage because of assignment to certain group(s)

dateCreatedstring(date-time)
managedBusinessesArray of integers(int64)

A list of businesses managed by this user

managedLocationsArray of integers(int64)

A list of locations managed by this user

connectedAccountsArray of strings
paymentMethodArray of strings
showSpSwitchboolean
isParentboolean
canManageLocationGroupsboolean
multiFactorAuthenticationsArray of objects(MultiFactorAuthentication)unique
managedLocationsIdentifiersArray of integers(int64)
curl -i -X POST \
  https://uberall.com/api/users \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "password": "string",
    "id": 0,
    "salutation": "string",
    "firstname": "string",
    "lastname": "string",
    "phone": "string",
    "status": "INVITED",
    "role": "UBER_API_ADMIN",
    "salesPartner": {
      "id": 0,
      "aggregateInvoicesToParent": true,
      "attribution": {
        "name": "string",
        "url": "string",
        "id": 0,
        "logo": {
          "url": "string",
          "type": "LOGO",
          "description": "string"
        }
      },
      "canSeePrices": true,
      "emailCustomerSupport": "string",
      "emailProjectLead": "string",
      "forceSso": true,
      "identifier": "string",
      "minPasswordLength": 0,
      "name": "string",
      "phone": "string",
      "preferredLanguage": "string",
      "pushUrl": "string",
      "salesPartnerStatus": "CREATED",
      "subscribedWebhookEventTypes": [
        "ADMIN_ALERT"
      ],
      "whitelistedRedirectUrls": [
        "string"
      ],
      "currency": "string",
      "entity": "UBERALL_BV",
      "isSsoActive": true,
      "maxFreeLocations": 0,
      "type": "string",
      "whitelabelInformations": [
        {
          "id": 0,
          "name": "string",
          "identifier": "string"
        }
      ],
      "onboardingStatus": "NOT_STARTED",
      "locationGroupIds": [
        0
      ],
      "country": "AF",
      "address": "string",
      "contactPerson": 0,
      "emailAccounting": "string",
      "vatId": "string",
      "parentId": 0,
      "priceMin": 0,
      "price": 0,
      "commission": 0
    },
    "preferredLanguage": "string",
    "identifier": "string",
    "features": [
      "NEW_PHOTO_TYPES"
    ],
    "emailSettings": [
      {
        "frequency": "ALWAYS",
        "emailType": "DIGEST",
        "id": 0
      }
    ],
    "featuresDetailed": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "whitelabelInformation": {
      "id": 0,
      "name": "string",
      "identifier": "string"
    },
    "roles": [
      "UBER_API_ADMIN"
    ],
    "locationGroupIds": [
      0
    ],
    "managedLocationsViaGroups": [
      0
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "managedBusinesses": [
      0
    ],
    "managedLocations": [
      0
    ],
    "connectedAccounts": [
      "string"
    ],
    "paymentMethod": [
      "string"
    ],
    "showSpSwitch": true,
    "isParent": true,
    "canManageLocationGroups": true,
    "multiFactorAuthentications": [
      {
        "email": "string",
        "type": "EMAIL",
        "id": 0
      }
    ],
    "managedLocationsIdentifiers": [
      0
    ]
  }'

Responses

Successfully created user

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​userobject

User Model

response.​usersLeftinteger(int32)

The number of users left

Example: 1
Response
No content

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations