---
title: "Search Services"
method: GET
path: "/public/user/service/search"
tags: ["Service"]
---

# Search Services

`GET /public/user/service/search`

Search Services on the customer account using various filters.

## Query parameters

- `service_id` string
- `service_status` 'awaiting_fulfillment' | 'awaiting_manual_fulfillment' | 'awaiting_additional_fulfillment' | 'active' | 'canceled' | 'complete' | 'overdue' | 'paused'
- `service_name` string
- `service_type` 'datacenter' | 'isp' | 'residential' | 'mobile'
- `service_protocol` 'ipv4' | 'ipv6' | 'dual'
- `service_quantity` integer
- `payment_method_id` integer
- `service_total` string
- `service_cycle` string
- `service_dispatch_datetime` string, date-time
- `service_expiry_datetime` string, date-time
- `service_image` string
- `service_is_automatic_collection` boolean
- `service_is_pending_cancellation` boolean
- `country_id` string
- `service_price_id` integer
- `product_id` integer
- `service_promotional_code` string
- `service_subscription_id` integer
- `service_creation_datetime` string, date-time
- `service_last_update_datetime` string, date-time
- `proxies` boolean
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successful Service search

- object — Service search was successful.
  - `data` object[] — Array of Service items matching the search criteria up to the limit of per_page paramater.
    - `country_id` string
    - `open_invoice_id` string
    - `payment_method_id` string
    - `service_creation_datetime` string, date-time
    - `service_cycle` string
    - `service_dispatch_datetime` string, date-time
    - `service_earliest_cancellation_datetime` string, date-time
    - `service_expiry_datetime` string, date-time
    - `service_id` string
    - `service_image` string
    - `service_is_automatic_collection` boolean
    - `service_is_pending_cancellation` boolean
    - `service_last_update_datetime` string, date-time
    - `service_metadata` object
    - `service_name` string
    - `service_promotional_code` string
    - `service_protocol` 'ipv4' | 'ipv6' | 'dual'
    - `service_quantity` integer
    - `service_status` 'awaiting_manual_fulfillment' | 'awaiting_additional_fulfillment' | 'awaiting_fulfillment' | 'active' | 'canceled' | 'complete' | 'paused' | 'overdue'
    - `service_subscription_id` string
    - `service_subscription_is_paused` boolean
    - `service_total` integer
    - `service_type` 'datacenter' | 'isp' | 'residential' | 'mobile' | 'off_catalog'
    - `subscription_schedule_id` string
    - `proxies` Proxy[]
      - `asn_id` integer
      - `asn_name` string
      - `city_example_postcode` string
      - `city_id` integer
      - `city_latitude` number
      - `city_longitude` number
      - `city_name` string
      - `city_timezone` string
      - `country_id` string
      - `country_name` string
      - `customer_id` integer
      - `default_proxy_user_password` string
      - `default_proxy_user_username` string
      - `ip_address_id_v4` string
      - `ip_address_id_v6` string
      - `proxy_http_port` integer
      - `proxy_id` string
      - `proxy_ip_address` string
      - `proxy_ip_address_v6` string
      - `proxy_last_update_datetime` string, date-time
      - `proxy_password` string
      - `proxy_protocol` 'ipv4' | 'ipv6' | 'dual'
      - `proxy_socks5_port` integer
      - `proxy_status` 'available' | 'in_use' | 'reserved' | 'waiting' | 'pending_deletion'
      - `proxy_type` 'datacenter' | 'isp' | 'residential' | 'mobile'
      - `proxy_user_ids` string[]
      - `proxy_username` string
      - `service_id` string
      - `subdivision_id` string
      - `subdivision_name` string
      - `subnet_id` string
      - `subnet_id_v6` string
  - `item_count` integer — Total number of Service items returned in the data field.
  - `message` string — Status message for the search.
  - `page` integer — Current page number of the search results returned.
  - `per_page` integer — Number of Service items returned per page.
  - `total_count` integer — Total of Service items that match the search filter.

---

[API](https://skmtc.dev/byteful/apis/byteful-public-user-api.md) · [All operations](https://skmtc.dev/byteful/apis/byteful-public-user-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/byteful/byteful-public-user-api/revisions/3db1a6fc0099/schema)