Retrieve All Credentials

GET

api

Account

{auth_id}

trunks

credentials

List credentials

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total": 3
  },
  "objects": [
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "acme_sip_user_01",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-25T10:00:00Z",
      "updated_at": "2026-03-25T10:00:00Z"
    },
    {
      "id": "99887766-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "office_phone_03",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-20T08:15:00Z",
      "updated_at": "2026-03-20T08:15:00Z"
    },
    {
      "id": "55667788-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "sipuser_demo",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-15T14:42:00Z",
      "updated_at": "2026-03-15T14:42:00Z"
    }
  ]
}

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials

Returns a paginated list of all credentials associated with the account. Use this endpoint to audit authentication credentials, review which usernames are in use, or identify disabled credentials that can be cleaned up.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Pagination Support: Results are paginated using limit and offset parameters. The response includes metadata showing the total count, current offset, and limit applied.

Query Parameters

Field	Type	Required	Description
`limit`	integer	No	Maximum number of credentials to return per page. Default: `20`.
`offset`	integer	No	Number of credentials to skip before returning results. Default: `0`. For example, `offset=20` with `limit=20` returns page 2.

Response

Returns a paginated response with metadata and an array of credential objects. Passwords are not included in the response.

Response - 200 OK

{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total": 3
  },
  "objects": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "sipuser_demo",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-04-22T08:51:47.813889Z",
      "updated_at": "2026-04-22T08:51:47.813889Z"
    },
    {
      "id": "11223344-5566-7788-99aa-bbccddeeff00",
      "account_id": "MA_XXXXXXXX",
      "username": "acme_sip_user",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-04-09T09:02:16.450443Z",
      "updated_at": "2026-04-09T09:02:16.450443Z"
    },
    {
      "id": "99887766-5544-3322-1100-ffeeddccbbaa",
      "account_id": "MA_XXXXXXXX",
      "username": "office_phone_03",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": false,
      "created_at": "2026-04-08T10:13:14.485836Z",
      "updated_at": "2026-04-20T16:30:00.000000Z"
    }
  ]
}

Examples

cURL - Default Pagination

cURL Request

curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

cURL - Custom Pagination

cURL Request

curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials?limit=10&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Pagination Tips:

Use total from metadata to calculate total pages
Increment offset by limit value for each subsequent page
Page 1: offset=0, Page 2: offset=20, Page 3: offset=40 (with limit=20)
Empty objects array indicates no more results

This endpoint is useful for credential management interfaces, auditing which credentials are active, and identifying unused credentials that can be safely removed.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

Response

200 - application/json

List of credentials

meta

object

required

Show child attributes

objects

object[]

required

Show child attributes

List credentials

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total": 3
  },
  "objects": [
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "acme_sip_user_01",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-25T10:00:00Z",
      "updated_at": "2026-03-25T10:00:00Z"
    },
    {
      "id": "99887766-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "office_phone_03",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-20T08:15:00Z",
      "updated_at": "2026-03-20T08:15:00Z"
    },
    {
      "id": "55667788-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "username": "sipuser_demo",
      "password": "<redacted>",
      "realm": "MA_XXXXXXXX.sip.vobiz.ai",
      "enabled": true,
      "created_at": "2026-03-15T14:42:00Z",
      "updated_at": "2026-03-15T14:42:00Z"
    }
  ]
}

​Query Parameters

​Response

​Examples

​cURL - Default Pagination

​cURL - Custom Pagination

Authorizations

Path Parameters

Response

Query Parameters

Response

Examples

cURL - Default Pagination

cURL - Custom Pagination