GETapi.synup.com/api/v4/locations/{locationId}/voice-assistants
Get voice listings for a location
This API retrieves all voice assistant listings associated with a specific location.
Available Voice Assistants:
- Google Assistant
- Cortana
- Alexa
- Siri
- Bixby
Response Includes:
- Sync status – Indicates whether the listing is successfully synced.
- Connection details – Provides integration status with each voice assistant.
- Potential issues – Highlights any errors preventing successful sync.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | The unique identifier of the location |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/locations/:locationId/voice-assistants' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/locations/:locationId/voice-assistants', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/locations/:locationId/voice-assistants",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/:locationId/voice-assistants", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Voice listings retrieved successfully |
400 | Bad request - invalid location ID |
401 | Unauthorized - invalid or missing API key |
403 | Forbidden - insufficient permissions |
404 | Location not found |
Example response
{
"data": {
"voiceAssistantsForLocation": [
{
"databaseId": "72246903",
"actionRequired": false,
"connectedAccountId": "2311f31a-ad73-4e2c-a063-6ae4a9d4c705",
"errors": [],
"voiceIdentifier": "GOOGLE_ASSISTANT",
"name": "Google Assistant",
"syncStatus": "IN_PROGRESS",
"syncIssue": null,
"__typename": "VoiceAssistant"
},
{
"databaseId": "72246683",
"actionRequired": false,
"connectedAccountId": null,
"errors": [],
"voiceIdentifier": "CORTANA",
"name": "Cortana",
"syncStatus": "IN_PROGRESS",
"syncIssue": null,
"__typename": "VoiceAssistant"
}
]
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.voiceAssistantsForLocation | array of object | optional | |
data.voiceAssistantsForLocation[].databaseId | string | optional | Internal database identifier |
data.voiceAssistantsForLocation[].actionRequired | boolean | optional | Indicates if user action is needed |
data.voiceAssistantsForLocation[].connectedAccountId | string | optional | ID of the connected account if available |
data.voiceAssistantsForLocation[].errors | array of string | optional | Array of error messages if any |
data.voiceAssistantsForLocation[].voiceIdentifier | string | optional | Unique identifier for the voice assistantGOOGLE_ASSISTANTCORTANAALEXASIRIBIXBY |
data.voiceAssistantsForLocation[].name | string | optional | Display name of the voice assistant |
data.voiceAssistantsForLocation[].syncStatus | string | optional | Current sync statusIN_PROGRESSCOMPLETEDFAILED |
data.voiceAssistantsForLocation[].syncIssue | string | optional | Description of any sync issues |
data.voiceAssistantsForLocation[].__typename | string | optional | GraphQL type name |