App Locations

For more information on locations, see Setting the app location in the Apps developer docs.

JSON Format

Locations are represented as JSON objects with the following properties:

Name Type Comment
id integer Internal location ID
name string The unique location key
product_code integer Internal product ID
host_application string The unique host application key
orderable Boolean True if reordering has any effect
collapsible Boolean True if collapsing has any effect
visible Boolean True if users can see and access location
Example
{
  "id": 1,
  "name": "top_bar",
  "product_code": 1,
  "host_application": "zendesk",
  "orderable": true,
  "collapsible": true,
  "visible": true
}

List Locations

GET /api/v2/apps/locations.json

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
Status: 200 OK

{
  "locations": [
    {
      "id": 1,
      "name": "top_bar",
      "host_application": "zendesk",
      "orderable": "true"
    },
    {
      "id": 2,
      "name": "nav_bar",
      "host_application": "zendesk",
      "orderable": "true"
    },
    {
      "id": 3,
      "name": "ticket_sidebar",
      "host_application": "zendesk",
      "orderable": "true"
    },
    {
      "id": 4,
      "name": "new_ticket_sidebar",
      "host_application": "zendesk",
      "orderable": "true"
    },
    {
      "id": 5,
      "name": "user_sidebar",
      "host_application": "zendesk",
      "orderable": "true"
    }
  ]
}

Show Location

GET /api/v2/apps/locations/{id}.json

Allowed For
  • Admins
Using curl
curl https://{subdomain}.zendesk.com/api/v2/apps/locations/{id}.json \
  -u {email_address}:{password}
Example Response
Status: 200 OK

{
  "location": {
    "id": 1,
    "name": "top_bar",
    "host_application": "zendesk"
  }
}