App Locations
For more information on locations, see Setting the app location in the Apps developer docs.
JSON format
App Locations are represented as JSON objects with the following properties:
Name | Type | Read-only | Mandatory | Description |
---|---|---|---|---|
collapsible | boolean | true | false | The value is true if reordering has any effect |
host_application | string | true | false | The unique host application key |
id | integer | true | false | Internal location ID |
name | string | true | false | The unique location key |
orderable | boolean | true | false | The value is true if reordering has any effect |
product_code | integer | true | false | Internal product ID |
visible | boolean | true | false | The value is true if users can see and access location |
Example
{
"collapsible": true,
"host_application": "zendesk",
"id": 1,
"name": "top_bar",
"orderable": true,
"product_code": 1,
"visible": true
}
List Locations
GET /api/v2/apps/locations
Returns a list of available locations for Zendesk apps.
Allowed For
- Admins
Using curl
curl https://{subdomain}.zendesk.com/api/v2/apps/locations.json \
-u {email_address}:{password}
Example response(s)
200 OK
Status 200 OK
{
"locations": [
{
"host_application": "zendesk",
"id": 1,
"name": "top_bar",
"orderable": true
},
{
"host_application": "zendesk",
"id": 2,
"name": "nav_bar",
"orderable": true
},
{
"host_application": "zendesk",
"id": 3,
"name": "ticket_sidebar",
"orderable": true
},
{
"host_application": "zendesk",
"id": 4,
"name": "new_ticket_sidebar",
"orderable": true
},
{
"host_application": "zendesk",
"id": 5,
"name": "user_sidebar",
"orderable": true
}
]
}
Show Location
GET /api/v2/apps/locations/{app_location_id}
Allowed For
- Admins
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
app_location_id | integer | Path | true | The ID of the app location |
Using curl
curl https://{subdomain}.zendesk.com/api/v2/apps/locations/{app_location_id}.json \
-u {email_address}:{password}
Example response(s)
200 OK
Status 200 OK
{
"location": {
"host_application": "zendesk",
"id": 1,
"name": "top_bar"
}
}