Search services

Search for one or more services.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Metadata
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

Query by created date.

date-time

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

Query by disconnected date

date-time

Query by disconnected date

date-time

Query by activated date

date-time

Query by activated date

search.address_id
array of int32s

Query by address primary identifier

search.address_id
date-time

Query by contract date

date-time

Query by contract date

boolean

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

string

Query by custom field display name (label). Must be paired with custom_field_value. Matching against the
name is case-insensitive and ignores leading/trailing whitespace. Must currently match at least one active
custom field defined for services, or the request fails with a clear error rather than silently returning
no matches - this covers the case where a name that was previously relied on gets renamed or deactivated,
as long as no other active field has since taken on that same name. If more than one active field shares
this name, matches from all of them are included together.

string

The value to match against the custom field identified by custom_field_name. Must be paired with
custom_field_name. Matching is exact (not partial), case-insensitive, and ignores leading/trailing
whitespace. An empty value matches services where the field has an explicitly blank/empty value;
services that never had a value set for this field at all are not matched.

int32

Defines how many items to return at a time.

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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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