v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Services

Search services

Search for one or more services.

get/v1/Services

Query parameters

search.service_idinteger[]

Query by service identifier. Required when filtering by active services only if no customer_id is provided.

search.customer_idinteger[]

Query by account identifier. Required when filtering by active services only if no service_id is provided.

search.provider_account_numberstring[]

Query by all or part of this text value.

search.numberstring[]

Query all or part of the number.

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.request_service_idinteger[]

Query by request service identifier.

search.number2string[]

Query all or part of the network-level identifier.

search.provider_idinteger[]

Query by provider primary identifier

search.service_type_idinteger[]

Query by the service type primary identifier

search.package_idinteger[]

Query by package primary identifier

search.provider_account_idinteger[]

Query provider account primary identifier

search.usage_plan_group_idinteger[]

Query by usage plan group primary identifier

search.descriptionstring[]

Query all or part of the description

search.disconnected_date_startstring date-time

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

search.disconnected_date_endstring date-time

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

search.activated_date_startstring date-time

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

search.activated_date_endstring date-time

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

search.address_idinteger[]

Query by address primary identifier

search.contract_startstring date-time

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

search.contract_endstring date-time

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

search.active_only_statusboolean

A filter to return only active services in the search results. Requires customer_id or service_id.

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.