All Connections

Retrieves connections of all types for an integration. See Understanding connections.

JSON format

All Connections are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
api_key array true false Array of API key connections. See API Key Connections
basic_auth array true false Array of basic authentication connections. See Basic Authentication Connections
bearer_token array true false Array of bearer token connections. See Bearer Token Connections
meta object true false Used to paginate results using cursor pagination
oauth array true false Array of OAuth connections. See OAuth Connections

Show Connections

  • GET /api/services/zis/integrations/{integration}/connections/all

Returns a list of connections for the integration.

Authentication

You can authorize requests using a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.

Pagination

  • Cursor pagination

See Pagination.

Returns a maximum of 100 records per page.

Parameters

Name Type In Required Description
page[after] string Query false Cursor for the next set of results
page[before] string Query false Cursor for the previous set of results
page[size] integer Query false Number of items to display in a results page. Can't exceed 100
integration string Path true Name of the integration

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/integrations/{integration}/connections/all \-H "Authorization: Bearer {access_token}"

Example response(s)

200 OK
Status 200 OK
{  "api_key": [    {      "allowed_domain": "api.example.com",      "api_key": "*****",      "created_at": "1985-04-12T23:20:50.52Z",      "header_name": "x-api-key",      "name": "my_api_key_connection",      "updated_at": "1985-04-12T23:20:50.52Z"    }  ],  "basic_auth": [    {      "allowed_domain": "api.example.com",      "created_at": "1985-04-12T23:20:50.52Z",      "name": "my_basic_auth_connection",      "password": "*****",      "updated_at": "1985-04-12T23:20:50.52Z",      "username": "[email protected]"    }  ],  "bearer_token": [    {      "allowed_domain": "api.example.com",      "created_at": "1985-04-12T23:20:50.52Z",      "name": "my_bearer_token_connection",      "token": "*****",      "updated_at": "1985-04-12T23:20:50.52Z"    }  ],  "meta": {    "after": "my_first_connection",    "before": "my_tenth_connection",    "has_more": true  },  "oauth": [    {      "access_token": "ps55XW1CbNj_hKnzwJU3yc968SL39yh3C3Okn1fpC-ThYWDqY2_M5w==",      "created_by": "test_user",      "name": "my_oauth_connection",      "oauth_access_token_response_body": "{\"access_token\":\"ps55XW1CbNj_hKnzwJU3yc968SL39yh3C3Okn1fpC\"}",      "oauth_url_subdomain": "foobar",      "permission_scope": "read write",      "refresh_token": "cs95Xaw_F5PKcxO4fQ9bZKklHKncdkXIc9qGrvktPt2elg==",      "token_expiry": "2021-10-01T12:44:22Z",      "token_type": "bearer",      "uuid": "ac10a230-0c43-45f8-b221-9e085ce90418"    }  ]}
401 Unauthorized
Status 401 Unauthorized
{  "errors": [    {      "code": "InvalidCredentials",      "title": "Token length is invalid"    }  ]}
403 Forbidden
Status 403 Forbidden
{  "errors": [    {      "code": "Forbidden",      "title": "Cannot access this resource. Missing scope write"    }  ]}
429 Too Many Requests
Status 429 Too Many Requests
{  "errors": [    {      "code": "TooManyRequests",      "title": "Too many requests"    }  ]}