v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
RequestServices

Search request services

Search for one or more request services.

get/v1/RequestServices

Query parameters

search.request_service_idinteger[]

Query by request service identifier.

search.request_idinteger[]

Query by request identifier.

search.request_address_idinteger[]

Query by request address identifier.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.numberstring[]

Query services by the provider identifier (i.e. Telephone Number).

search.number2string[]

Query services by the network-level identifier, provider-side (i.e. Circuit ID).

search.provider_account_numberstring[]

Query services by the secondary identifier, provider-side.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.