voice-trunks

List a SIP trunk's gateways

Returns the gateway addresses used to forward inbound calls to this trunk, ordered by priority. A trunk with no gateway refuses inbound calls. Returns a 404 Not Found error if the trunk does not exist in the workspace.

Returns the complete collection without pagination, including any pre-existing gateways above the current limit of 20. Reads are available when inbound calling is disabled.

get/v1/voice/trunks/{trunk_id}/gateways

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/voice/trunks/{trunk_id}/gateways
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The complete gateway list, ordered by priority and then creation time.

Example response

{
  "data": [
    {
      "id": "vtg_01krdgeqcxet5s7t44vh8rt9mg",
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "sip_uri": "sip:pbx.example.com:5060",
      "origination_format": "+{number}",
      "destination_format": "+{number}",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.