Search services

Search for one or more services.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
search.service_id
array of int32s

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

search.service_id
search.customer_id
array of int32s

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

search.customer_id
search.provider_account_number
array of strings

Query by all or part of this text value.

search.provider_account_number
search.number
array of strings

Query all or part of the number.

search.number
date-time

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

date-time

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

search.request_service_id
array of int32s

Query by request service identifier.

search.request_service_id
search.number2
array of strings

Query all or part of the network-level identifier.

search.number2
search.provider_id
array of int32s

Query by provider primary identifier

search.provider_id
search.service_type_id
array of int32s

Query by the service type primary identifier

search.service_type_id
search.package_id
array of int32s

Query by package primary identifier

search.package_id
search.provider_account_id
array of int32s

Query provider account primary identifier

search.provider_account_id
search.usage_plan_group_id
array of int32s

Query by usage plan group primary identifier

search.usage_plan_group_id
search.description
array of strings

Query all or part of the description

search.description
date-time

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

date-time

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

date-time

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

date-time

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

search.address_id
array of int32s

Query by address primary identifier

search.address_id
date-time

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

date-time

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

boolean

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

int32

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

int32

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

string

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html