Skip to content
API Reference/
/
Directories

Directories

Request

Get a list of directories where a posting is possible for the given combination of parameters. The response also contains warnings like missing directory connections.

Security
X-API-KEY or Authorization
Query
locationIdsArray of strings

Return directories where posting is possible for these locationIds

businessIdsArray of strings

Return directories where posting is possible for these businessIds

locationGroupIdsArray of strings

Return directories where posting is possible for these locationGroupIds

labelsArray of strings

Return directories where posting is possible for these labels

excludedLocationIdsArray of strings

List of excluded locationIds

curl -i -X GET \
  'https://uberall.com/api/social-posts/directories?locationIds=string&businessIds=string&locationGroupIds=string&labels=string&excludedLocationIds=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Directories retrieved

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

Social Post Directories Response Model

Response
GetSocialPostDirectoriesExample
{
  "status": "SUCCESS",
  "response": {
    "directories": [ … ],
    "directoryWarnings": [],
    "googleAlertTypes": [ … ],
    "locationWarnings": [],
    "totalLocationsCount": 1
  }
}