---
title: "Search customer relationships"
method: GET
path: "/v1/CustomerRelationships"
tags: ["CustomerRelationships"]
---

# Search customer relationships

`GET /v1/CustomerRelationships`

Search for one or more customer relationships.

## Query parameters

- `search.customer_relationship_id` integer[]
- `search.customer_id` integer[]
- `search.related_customer_id` integer[]
- `search.customer_relationship_type_id` integer[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsCustomerRelationship
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsCustomerRelationship[] — List of records returned.
    - `customer_relationship_id` integer — Primary identifier for this customer relationship.
    - `customer_id` integer, required — Primary customer that has a relationship with another customer.
    - `related_customer_id` integer, required — Customer that is related to the primary customer.
    - `customer_relationship_type_id` integer, required — Foreign identifier for the type of relationship between the two customers.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)