Search services

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

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

Query by all or part of this text value.

Query all or part of the number.

Query by created date.

Query by created date.

Query by request service identifier.

Query all or part of the network-level identifier.

Query by provider primary identifier

Query by the service type primary identifier

Query by package primary identifier

Query provider account primary identifier

Query by usage plan group primary identifier

Query all or part of the description

Query by disconnected date

Query by disconnected date

Query by activated date

Query by activated date

Query by address primary identifier

Query by contract date

Query by contract date

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

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.

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.

Defines how many items to return at a time.

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

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