# Get Several Locations

Get locations managed by the current API user. Some fields are omitted (such as paymentOptions and services). For a full list use the GET/api/locations/$id endpoint.

Endpoint: GET /locations
Version: 20250708
Security: X-API-KEY, Authorization

## Query parameters:

  - `businessId` (array)
    Only return locations in the business identified by businessId. Allowed multiple businessIds
    Example: "/api/locations?businessId=123&businessId=456"

  - `businessIds` (array)
    Returns all locations associated with multiple business ids

  - `cities` (array)
    Get locations in the requested cities

  - `classification` (string)
    Possible values: REQUIRED, BASIC, ADVANCED, BONUS and COMPLETE

  - `countries` (array)
    Get locations in the requested country

  - `endDateMax` (string)
    Only locations with an endDate less than or equal to endDateMax will be returned
    Example: "2020-02-05T12:18:12.000+01:00"

  - `endDateMin` (string)
    Only locations with an endDate greater than or equal to endDateMin will be returned.
    Example: "2018-02-05T12:18:12.000+01:00"

  - `excludedLocationIds` (array)
    List of locationIds that should be excluded from the result
    Example: "excludedLocationIds=20&excludedLocationIds=21 for multiple locations"

  - `facebookStatus` (string)
    Possible values: CONNECTED, NOT_CONNECTED

  - `fieldMask` (array)
    Possible fieldMask options ( 'id', 'name', 'identifier', 'street', 'streetNo', 'streetAndNumber', 'addressExtra', 'zip', 'city', 'country',
                                                               'dateCreated', 'endDate', 'province', 'lat', 'lng', 'addressDisplay', 'phone', 'fax', 'timeZone',
                                                               'cellphone', 'website', 'email', 'legalIdent', 'taxNumber', 'descriptionShort',
                                                               'descriptionLong', 'imprint', 'openingHoursNotes', 'status', 'photos', 'attributes',
                                                               'firstSyncStarted', 'lastUpdated', 'lastSyncStarted', 'autoSync', 'locationSyncable', 'businessId', 'businessName', 'productPlanName',
                                                               'googleInsights', 'labels', 'customFields', 'features', 'groups', 'openingHours', 'specialOpeningHours', 'nameDescriptor',
                                                               'actionsRequired', 'profileCompleteness', 'suggestionsForFieldsAvailable', 'listingsInSync', 'activeListingsCount',
                                                               'dataPoints', 'averageRating', 'directoriesMissingConnect' )
    Example: "fieldMask=city&fieldMask=zip"

  - `googleDirectoryStatus` (string)
    Possible values: VERIFIED (the Google listing is verified and fully managed by us),
                            UNVERIFIED (the Google listing is not verified),
                            DISABLED (the Google listing is disabled),
                            SUSPENDED (the Google listing is suspended),
                            DUPLICATE (the Google listing is a duplicate),
                            PENDING_VERIFICATION (a verification pin has been requested for the Google listing),
                            NEEDS_REVERIFICATION (the verification process for the Google listing needs to be reverified),
                            PENDING_REVIEW (there is no Google account connected for the listing)

  - `googleStatus` (string)
    Possible values: VERIFIED (the Google listing is verified and fully managed by us),
                            VERIFICATION_STARTED (a verification pin has been requested for the Google listing),
                            VERIFICATION_NOT_STARTED (the verification process has not been start for the Google listing),
                            NOT_CONNECTED (there is no Google account connected for the listing),
                            VERIFIED_BY_THIRD_PARTY (there is a verified listing on Google but we do not manage it)

  - `groupIds` (array)
    The groupId to which the location belongs

  - `groups` (array)
    The name of the group to which the location belongs

  - `identifier` (string)
    Only return one location (per business) based on your internal identification system

  - `labels` (array)
    Only return locations that contain at least one of the given labels

  - `locationIds` (array)
    Only return locations identified by ids listed in locationIds
    Example: "?locationIds=20&locationIds=22 for multiple locations"

  - `max` (integer)
    Used for pagination. Maximum number of results per page. Default: 50 (Without a defined FieldMask the maximum number of results is 50.)

  - `missingDirectoryField` (array)
    Only return locations that have no value for the given field

  - `needsReview` (boolean)
    If set to true, only return locations with faulty data in need of review. Default: false.

  - `offset` (integer)
    Offset used for pagination. Default: 0

  - `order` (string)
    use asc for ascending sort or desc for descending sort

  - `postcodes` (array)
    Get locations in the requested post / zip codes

  - `provinces` (array)
    Get locations in the requested province / state

  - `query` (string)
    Filter by name, zip, street, city, label
    Example: "Berlin"

  - `queryFields` (array)
    The fields that will be searched to contain the value provided in the 'query' query parameter.

  - `selectAll` (boolean)
    Setting selectAll to true allows finding ALL locations for any given businessId, locationIds and labels. In other words these fields are OR joined.

  - `sort` (string)
    The location property to sort by (ascending unless order is specified).
                            One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country

  - `status` (array)
    Filter by locations status. One of ACTIVE, INACTIVE, CANCELLED

  - `syncNeeded` (boolean)
    If set to true, filter locations that have been updated but did not start a sync yet

  - `syncStarted` (boolean)
    If set to true, filter locations that started a sync. If set to false, filter locations that never synced

  - `temporarilyClosed` (boolean)
    Filter for locations that are currently set to temporarily closed (True) or are not temporarily closed (False)

## Response 200 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `warnings` (array)
    (optional) Holds further warnings

  - `response` (object, required)
    The actual response object of the response

  - `response.offset` (integer)
    Offset for pagination

  - `response.max` (integer)
    Maximum number of results per page
    Example: 10

  - `response.count` (integer)
    Total count of results
    Example: 100

  - `response.locations` (array)

  - `response.locations.id` (integer)
    The uberall unique id for the location

  - `response.locations.identifier` (string)
    The location identifier based on your internal identification system

  - `response.locations.name` (string)
    The location's name

  - `response.locations.street` (string)
    The location's street address

  - `response.locations.streetNo` (string)
    The location's street number

  - `response.locations.streetType` (string)
    Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
    Enum: "ALAMEDA", "AVENIDA", "CALLE", "CAMINO", "CARRER", "CARRETERA", "GLORIETA", "KALEA", "PASAJE", "PASEO", "PLACA", "PLAZA", "RAMBLA", "RONDA", "RUA", "SECTOR", "TRAVESERA", "TRAVESIA", "URBANIZACION"

  - `response.locations.addressExtra` (string)
    An address extra: e.g. building, floor...
    Example: "building, floor..."

  - `response.locations.addressDisplay` (boolean)
    If set to false, directories are either not given address details or told not to display them. There are few directories where this is not possible, that hence might not receive data at all.

  - `response.locations.zip` (string)
    Zip code

  - `response.locations.city` (string)
    City

  - `response.locations.province` (string)
    Province. Only send when not blank

  - `response.locations.country` (string)
    Country. One of AT, CH, DE, ES, UK, FR, IT, NL
    Enum: "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "UK", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"

  - `response.locations.lat` (number)
    The latitude coordinate of the location

  - `response.locations.lng` (number)
    The longitude coordinate of the location

  - `response.locations.locationSyncable` (boolean)
    Boolean indicating whether the location has been updated and can be synced

  - `response.locations.phone` (string)
    The location's contact phone number

  - `response.locations.fax` (string)
    The location fax number

  - `response.locations.cellphone` (string)
    A contact mobile phone number

  - `response.locations.website` (string)
    A valid url for the location's website (use UTMs to add tracking)

  - `response.locations.email` (string)
    A contact email for the location

  - `response.locations.hasFacebook` (boolean)
    Boolean indicating whether the location has support Facebook included in its product plan

  - `response.locations.legalIdent` (string)
    A legal identifier of the location. SIRET number in France

  - `response.locations.taxNumber` (string)
    The tax number of the location. CIF/NIF in Spain

  - `response.locations.descriptionShort` (string)
    A short description (up to 200 characters) for the location

  - `response.locations.descriptionLong` (string)
    A long description (up to 1000 characters) for the location

  - `response.locations.imprint` (string)
    imprint of the location

  - `response.locations.openingHoursNotes` (string)
    Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters
    Example: "We never open on bank holidays"

  - `response.locations.openingHours` (array)
    The location's opening hours: e.g.
[ { 
    "dayOfWeek": 1,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00"
  }, 
  {
    "dayOfWeek": 2,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00",
    "from2": "13:00",
    "to2": "21:00"
  },
  {
    "dayOfWeek": 3,
    "closed": true
  }
]
Please note that having more than 2 time periods for each day is not possible.
    Example: [{"dayOfWeek":1,"closed":false,"from1":"08:00","to1":"11:00"},{"dayOfWeek":2,"closed":false,"from1":"08:00","to1":"11:00","from2":"13:00","to2":"21:00"},{"dayOfWeek":3,"closed":true}]

  - `response.locations.openingHours.closed` (boolean)
    Indicates whether a location is closed on a day.

  - `response.locations.openingHours.toX` (string)
    An end of a period. One or multiple periods are supported per dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00"

  - `response.locations.openingHours.fromX` (string)
    A beginning of a period. One or multiple periods are supported per dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00"

  - `response.locations.openingHours.dayOfWeek` (integer, required)
    The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday, ...

  - `response.locations.specialOpeningHours` (array)
    The location's special opening hours: e.g.
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": "16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
    Example: [{"date":"2017-06-29","closed":true},{"date":"2017-06-30","from1":"11:00","to1":"14:00","from2":"16:00","to2":"20:00"}]

  - `response.locations.specialOpeningHours.closed` (boolean)
    Indicates whether a location is closed on a date.

  - `response.locations.specialOpeningHours.date` (string, required)
    The date of a special opening hour, e.g.: 2017-06-30

  - `response.locations.specialOpeningHours.toX` (string)
    An end of a period. Up to two periods are supported per date, e.g.: "to1": "09:00", "to2": "15:00"

  - `response.locations.specialOpeningHours.fromX` (string)
    A beginning of a period. Up to two periods are supported per date, e.g.: "from1": "09:00", "from2": "15:00"

  - `response.locations.openNow` (boolean)
    Used for store finder. Boolean indicating whether the location is currently open

  - `response.locations.keywords` (array)
    Keywords describing the location's activity

  - `response.locations.labels` (array)
    Labels grouping similar locations
    Example: "['Campaign2018', 'EastCoast']"

  - `response.locations.labels.name` (string, required)
    Label name as String.

  - `response.locations.labels.adminOnly` (boolean)
    Permission on label, whether it can be used by admins or everyone.

  - `response.locations.categories` (array)
    Required - A list of category IDs describing the location

  - `response.locations.attributes` (array)
    The location's Google attributes

  - `response.locations.attributes.externalId` (string)
    The google attribute id

  - `response.locations.attributes.value` (string)
    The value of the attribute. The value depends on the valueType.
BOOL: "true" or "false"
Single URL:"http://uberall.com" 
Multiple URLs: ["http://uberall.com", "https://menuari2.com"] 
ENUM:"supportedValue1" or "supportedValue2"
REPEATED_ENUM:"supportedValue1,supportedValue2"

  - `response.locations.attributes.displayName` (string)
    The attribute's name in the required language.

  - `response.locations.attributes.groupDisplayName` (string)
    Attribute group name

  - `response.locations.attributes.valueMetadata` (array)
    List of possible values.

  - `response.locations.attributes.valueMetadata.value` (string)
    The value

  - `response.locations.attributes.valueMetadata.displayName` (string)
    Display name for this value

  - `response.locations.attributes.valueType` (string)
    The attribute type.
e.g. BOOL, URL, ENUM, REPEATED_ENUM
    Enum: "BOOL", "URL", "ENUM", "REPEATED_ENUM"

  - `response.locations.status` (string)
    The status of the location. One of:
ACTIVE - will be synced and renewed
INACTIVE - will not be synced anymore, claims of listings will be released where possible
CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
    Enum: "CREATED", "ACTIVE", "INACTIVE", "CANCELLED", "DELETED", "CLOSED"

  - `response.locations.lastSyncStarted` (string)
    Output only. Date of the last sync for the location

  - `response.locations.endDate` (string)
    The date the location's contract expires

  - `response.locations.cancellationDate` (string)
    The date when the location was cancelled

  - `response.locations.dateCreated` (string)
    The date and time the location was created

  - `response.locations.lastUpdated` (string)
    Output only. Date of the last changes made to the location

  - `response.locations.sortableData` (object)
    A JSON indicating which parameters can be used when sorting a list of locations including this one

  - `response.locations.sortableData.activeDirectoriesCount` (integer)
    Output only. Number of active directories

  - `response.locations.sortableData.activeListingsCount` (integer)
    Output only. Number of active listings

  - `response.locations.sortableData.publishedListingsCount` (integer)
    Number of managed online listings

  - `response.locations.sortableData.visibilityIndex` (integer)
    Latest Visibility Index

  - `response.locations.sortableData.dataPoints` (integer)
    Number of datapoints

  - `response.locations.sortableData.businessId` (integer)
    Uberall Identifier of the location's business

  - `response.locations.sortableData.salesPartnerId` (integer)
    Uberall identifier of the SalesPartner

  - `response.locations.sortableData.profileCompleteness` (integer)
    Output only. Number representing completeness of location data, up to 100

  - `response.locations.sortableData.missingMandatoryFields` (array)
    Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
    Enum: "NAME", "NAME_DESCRIPTOR", "STREET_NO", "STREET", "STREET_TYPE", "ADDRESS_EXTRA", "PROVINCE", "ZIP", "CITY", "COUNTRY", "LATITUDE", "LONGITUDE", "ADDRESS_DISPLAY", "SERVICE_AREAS", "CATEGORIES", "OPENING_DATE", "PHONE", "CELLPHONE", "FAX", "WEBSITE", "WEBSITE_EXTRA", "EMAIL", "OPENINGHOURS", "OPENINGHOURS_NOTES", "SPECIAL_OPENINGHOURS", "MORE_HOURS", "KEYWORDS", "DESCRIPTION_SHORT", "DESCRIPTION_LONG", "IMPRINT", "LEGAL_IDENT", "TAX_NUMBER", "ATTRIBUTION", "IS_PUBLISHED", "SOCIAL_PROFILES", "ATTRIBUTES", "PAYMENT_OPTIONS", "BRANDS", "LANGUAGES", "SERVICES", "CONTENT_LISTS", "PHOTOS", "VIDEOS", "SOCIAL_POST", "DOCTOR_CATEGORIES", "NPI", "EV_DATA", "TRANSACTION_LINKS", "SUBLOCALITY", "CUSTOM_FIELDS"

  - `response.locations.sortableData.directoriesMissingConnect` (array)
    The list of DirectoryType missing connection
    Enum: "NAME", "NAME_DESCRIPTOR", "STREET_NO", "STREET", "STREET_TYPE", "ADDRESS_EXTRA", "PROVINCE", "ZIP", "CITY", "COUNTRY", "LATITUDE", "LONGITUDE", "ADDRESS_DISPLAY", "SERVICE_AREAS", "CATEGORIES", "OPENING_DATE", "PHONE", "CELLPHONE", "FAX", "WEBSITE", "WEBSITE_EXTRA", "EMAIL", "OPENINGHOURS", "OPENINGHOURS_NOTES", "SPECIAL_OPENINGHOURS", "MORE_HOURS", "KEYWORDS", "DESCRIPTION_SHORT", "DESCRIPTION_LONG", "IMPRINT", "LEGAL_IDENT", "TAX_NUMBER", "ATTRIBUTION", "IS_PUBLISHED", "SOCIAL_PROFILES", "ATTRIBUTES", "PAYMENT_OPTIONS", "BRANDS", "LANGUAGES", "SERVICES", "CONTENT_LISTS", "PHOTOS", "VIDEOS", "SOCIAL_POST", "DOCTOR_CATEGORIES", "NPI", "EV_DATA", "TRANSACTION_LINKS", "SUBLOCALITY", "CUSTOM_FIELDS"

  - `response.locations.sortableData.listingsInSync` (integer)
    number of listings still in sync

  - `response.locations.sortableData.listingsBeingUpdated` (integer)
    Output only. Number of listings still being updated

  - `response.locations.sortableData.averageRating` (number)
    Average rating, e.g.

  - `response.locations.sortableData.suggestionsForFieldsAvailable` (boolean)
    Output Only. Boolean that indicates which locations have pending suggestions.

  - `response.locations.businessId` (integer)
    The id of the business associated with this location

  - `response.locations.socialPostId` (integer)
    Social Post Id of the location

  - `response.locations.distance` (integer)
    Used for store finder. The distance between the current position and this location

  - `response.locations.photos` (array)
    List of Photos

  - `response.locations.photos.description` (string)
    A description for the photo - max 255 chars

  - `response.locations.photos.sourceUrl` (string)
    The URL to the original photo

  - `response.locations.photos.identifier` (string)
    The photo identifier based on your internal identification system

  - `response.locations.photos.cropOffsetX` (integer)
    Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]

  - `response.locations.photos.cropOffsetY` (integer)
    Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]

  - `response.locations.photos.cropWidth` (integer)
    Width of the 16:9 cropped area [LANDSCAPE photo only]

  - `response.locations.photos.cropHeight` (integer)
    Height of the 16:9 cropped area [LANDSCAPE photo only]

  - `response.locations.photos.type` (string, required)
    Required - One of: 

MAIN 
LOGO 
SQUARED_LOGO 
DOCTOR_COM_PORTRAIT - Doctor.com clients only 
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE 
PHOTO  
STOREFINDER_LOGO - Only for Uberall locator product 
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo 
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category 
INTERIOR - Google's Interior Photo tag  - availability dependent on a location's business category 
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category  
MENU  - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category 
PRODUCT  - Google's Product Photo tag - availability dependent on a location's business category 
TEAMS  - Google's Teams Photo tag - availability dependent on a location's business category 
AT_WORK  - Google's At Work Photo tag - availability dependent on a location's business category 
COMMON_AREA  - Google's Common Area Photo tag - availability dependent on a location's business category 
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
    Enum: "MAIN", "DOCTOR_COM_PORTRAIT", "LOGO", "STOREFINDER_LOGO", "SQUARED_LOGO", "LANDSCAPE", "STOREFINDER_COVER", "FACEBOOK_LANDSCAPE", "APPLE_LANDSCAPE", "MENU", "PHOTO", "ROOMS", "TEAMS", "AT_WORK", "PRODUCT", "EXTERIOR", "INTERIOR", "COMMON_AREA", "FOOD_AND_DRINK"

  - `response.locations.photos.order` (integer)
    Sets the order in which the photos should be shown

  - `response.locations.photos.dateCreated` (string)
    The date when the object was created in uberall database

  - `response.locations.photos.lastUpdated` (string)
    Date of the last changes made to the photo

  - `response.locations.photos.photo` (string, required)

  - `response.locations.photos.locationId` (integer, required)

  - `response.locations.autoSync` (boolean)
    When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.

  - `response.locations.skipFacebookPicturesUpdate` (boolean)
    Skip updating photos on Facebook
    Example: true

  - `response.locations.suggestionsForFieldsAvailable` (boolean)
    true if any suggetions are available

  - `response.locations.features` (array)
    Output only. List of features available to the location

## Response 400 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 401 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 403 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 404 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response