---
title: "Search Service Adjustments"
method: GET
path: "/public/user/service_adjustment/search"
tags: ["Service Adjustment"]
---

# Search Service Adjustments

`GET /public/user/service_adjustment/search`

Search Service Adjustments on the customer account using various filters.

## Query parameters

- `invoice_id` string
- `service_id` string
- `service_adjustment_id` integer
- `service_adjustment_type` 'ingestion' | 'fulfillment' | 'update' | 'proxy_replacement' | 'extension' | 'cancel' | 'remove_proxy' | 'additional_fulfillment' | 'top_up' | 'top_up_and_extension' | 'cancel'
- `service_adjustment_status` 'pending' | 'complete' | 'failed'
- `service_adjustment_is_administrator` boolean
- `service_adjustment_is_automatic` boolean
- `service_adjustment_is_customer` boolean
- `service_adjustment_creation_datetime` string, date-time
- `service_adjustment_last_update_datetime` string, date-time
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successful Service Adjustment search

- object — Service Adjustment search was successful.
  - `data` object[] — Array of Service Adjustment items matching the search criteria up to the limit of per_page paramater.
    - `invoice_id` string
    - `service_adjustment_creation_datetime` string, date-time
    - `service_adjustment_eval` object
    - `service_adjustment_id` integer
    - `service_adjustment_is_administrator` boolean
    - `service_adjustment_is_automatic` boolean
    - `service_adjustment_is_customer` boolean
    - `service_adjustment_last_update_datetime` string, date-time
    - `service_adjustment_post` object
    - `service_adjustment_pre` object
    - `service_adjustment_status` 'complete' | 'pending' | 'failed'
    - `service_adjustment_type` 'ingestion' | 'fulfillment' | 'remove_proxy' | 'additional_fulfillment' | 'update' | 'proxy_replacement' | 'extension' | 'top_up' | 'top_up_and_extension' | 'cancel'
    - `service_id` string
    - `proxy_replacements` ProxyReplacement[]
      - `proxy_replacement_creation_datetime` string, date-time
      - `proxy_replacement_http_port` integer
      - `proxy_replacement_id` integer
      - `proxy_replacement_ip_address_ipv4` string
      - `proxy_replacement_ip_address_ipv6` string
      - `proxy_replacement_new_http_port` integer
      - `proxy_replacement_new_ip_address_ipv4` string
      - `proxy_replacement_new_ip_address_ipv6` string
      - `proxy_replacement_new_socks5_port` integer
      - `proxy_replacement_reason` 'customer_request' | 'ip_reputation' | 'end_of_deployment' | 'outage' | 'other'
      - `proxy_replacement_socks5_port` integer
  - `item_count` integer — Total number of Service Adjustment 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 Adjustment items returned per page.
  - `total_count` integer — Total of Service Adjustment 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)