Get Numbers Collection

get

https://api.telmetrics.com/v3/api/numbers

Gets a colleciton of numbers.

Query Params

searchBy

string | null

Filter numbers returned by the API. Supported options: type, number, name

criteria

string | null

The criteria to search by.

sortBy

string | null

The field to sort the results by. Supported options: number, name, created, updated

pageSize

int32 | null

Determines how many results will be returned in a page. If this value isn't passed, the pageSize will default to the maximum size for that collection.

pageNumber

int32 | null

Used to page through the results from your request. If this value is not provided, it will default to page 1.

sortDir

string | null

The direction to display the results.

Supported Options: asc, desc

Headers

Authorization

string

Defaults to Bearer

Access token. Required if x-organization-token is not provided.

x-organization-token

string

Organization token. Required if Authorization token is not provided.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad request. Please check your payload.

401Unauthorized. Please check your token or request.

404The item you are requesting was not found.

500Server Error