---
title: "List a SIP trunk's gateways"
method: GET
path: "/v1/voice/trunks/{trunk_id}/gateways"
tags: ["voice-trunks"]
---

# List a SIP trunk's gateways

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

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.

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

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

- VoiceTrunkGatewayList: The trunk's gateways. Not paginated: a trunk holds a small, hand-managed set of dial targets, and the order across the whole set is what decides hunt order, so a partial page would misrepresent it.
  - `data` VoiceTrunkGateway[], required: The trunk's gateways, in priority order.
    - `id` string, required
    - `trunk_id` string, required
    - `sip_uri` string, required: SIP URI an inbound call to this trunk is forwarded to. The host only: which number is dialed at that host comes from `destination_format`, because it changes with every call.
    - `priority` integer, required: The order gateways are tried in, lowest first. Gateways sharing a priority take an equal share of calls, and any of them may be tried first on a given call.
    - `origination_format` string, required: How the calling number is spelled to this gateway, as a template whose `{number}` stands for the number without its leading `+`. It is stated in the `P-Asserted-Identity` header of the delivered call. A gateway that has not asked for anything else reports `+{number}`, which is E.164. A format with no `{number}` states that same identity on every call, whoever called.
    - `destination_format` string, required: How this gateway formats the dialed number. In the template, `{number}` represents the number without its leading `+`. The result is placed before the `sip_uri` host. For example, `1234#{number}` formats `+31201234567` as `sip:1234#31201234567@pbx.example.com:5060`. A gateway that has not asked for anything else reports `+{number}`, which is E.164. A format with no `{number}` is dialed as it stands, so every number the trunk answers reaches that one number.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)