Retrieve All Credentials

List all SIP credentials associated with a trunk.

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

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

HTTP Request

GEThttps://api.vobiz.ai/api/v1/account/{account_id}/trunks/credentials

Authentication: Bearer token required. Include X-Auth-ID header.

Query Parameters

Request Parameters

Name	Type	Description
`limit`	integer	Maximum number of credentials to return per page. Default: 20. Useful for controlling response size.
`offset`	integer	Number of credentials to skip before starting to return results. Default: 0. Used for pagination - e.g., offset=20 with limit=20 returns page 2.

Response

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

Response - 200 OK

{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 3
  },
  "objects": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",

      "username": "trunk_user_001",
      "enabled": true,
      "description": "Primary trunk credential",
      "created_at": "2025-01-15T10:35:20Z",
      "updated_at": "2025-01-15T10:35:20Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",

      "username": "trunk_user_002",
      "enabled": true,
      "description": "Backup credential",
      "created_at": "2025-01-16T14:20:30Z",
      "updated_at": "2025-01-16T14:20:30Z"
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",

      "username": "trunk_user_003",
      "enabled": false,
      "description": "Disabled test credential",
      "created_at": "2025-01-17T09:15:45Z",
      "updated_at": "2025-01-20T16:30:00Z"
    }
  ]
}

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_count 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

Use Case: This endpoint is ideal for displaying credential management interfaces, auditing which credentials are active, and identifying unused credentials that can be safely removed.

Create Credential

Update Credential