---
title: "List providers"
method: GET
path: "/providers"
tags: ["Trunk"]
---

# List providers

`GET /providers`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/providers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/providers/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of providers

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `name` string: The name of the trunk.
    - `enabled` boolean: Whether to enable the provider.
    - `brand` string: The brand of trunk.
    - `hostname` string: Server hostname or IP address
    - `port` integer: A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
    - `did_numbers` string: The semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers.
    - `shared` boolean: The flag of whether the trunk is shared.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)