SIsinch
Services

List numbers for service

Changed on

List numbers for a service.

get/v3/projects/{projectId}/services/{id}/numbers

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services/{id}/numbers
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

idstring required

The serviceId containing the numbers you want to list.

Query parameters

pageSizeinteger
Example:20

Number of items to return on each page.

pagestring

Optional. The page to fetch. If not specified, the first page will be returned.

Response

The list of numbers, or an Error

pageinteger

Current page

totalPagesinteger

Total number of pages.

pageSizeinteger

Number of items per page.

totalItemsinteger

Total size of the result.

Example response

{
  "numbers": [
    {
      "phoneNumber": "+15551235656",
      "country": "US",
      "suspended": true,
      "note": "Reason for suspending the number.",
      "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
      "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
    }
  ]
}

Changes