List all numbers

List all numbers

Query Parameters

page integer

Default value: 1

The page number to retrieve

perPage integer

Default value: 10

The number of items per page

Responses

• 200
• 401

---

Successfully retrieved the number(s)

application/json

Schema

Example (from schema)

---

Schema

data object[]
Array [
id string
The ID of the number
label string nullable
The label of the number
number string
The phone number in E.164 format
status string
Possible values: [ACTIVE, SUSPENDED, CANCELLED, PARKED, PENDING_PORTING_IN, PENDING_REGION_VALIDATION, PENDING_ACTIVATION]
The status of the number
]
meta object

pagination object

totalItems integer

The number of items in the collection

totalPages integer

The number of pages in the collection

currentPage integer

The current page

perPage integer

Possible values: >= 1 and <= 50

The number of items per page

links object

self uri

The url to the first page

first uri

The url to the first page

last uri

The url to the last page

previous uri nullable

The url to the previous page

next uri nullable

The url to the next page

{
  "data": [
    {
      "id": "64b8e900cbe7501ee8467d3e",
      "label": "Rinkel",
      "number": "+31850609000",
      "status": "ACTIVE"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 100,
      "totalPages": 10,
      "currentPage": 1,
      "perPage": 10
    },
    "links": {
      "self": "https://api.rinkel.com/users?page=1",
      "first": "https://api.rinkel.com/users?page=1",
      "last": "https://api.rinkel.com/users?page=10",
      "previous": null,
      "next": "https://api.rinkel.com/users?page=2"
    }
  }
}

Unauthorized

Loading...