# SearchParticipants

Returns a list of participants matching the input query.

`GET /trading-partners`

**API:** Avalara E-Invoicing API
**Tag:** Trading Partners
**API Version:** 1.5
**Base URL:** https://api.sbx.avalara.com/einvoicing
**Authentication:** Bearer token

Source: https://developer.avalara.com/products/e-invoicing/api/v1.5/methods/Trading%20Partners/SearchParticipants/

## Description

This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.

## Parameters

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `avalara-version` | string | header | Yes | Header that specifies the API version to use (for example "1.5"). |
| `X-Avalara-Client` | string | header | No | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). |
| `count` | boolean | query | No | When set to true, returns the total count of matching records included as @recordSetCount in the response body. |
| `$search` | string | query | Yes | Search by value supports logical AND and OR operators (case-sensitive). Search is performed only over the name and identifier value fields. For more information, refer to the OData query options overview documentation. |
| `$filter` | string | query | No | Filters the results using the eq operator. Supported fields include network, country, documentType, and idType. For more information, refer to the Avalara filtering guide. |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `$orderBy` | string | query | No | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. |
| `X-Correlation-ID` | string | header | No | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). |

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | Returns a collection of trading partners matching the specified search criteria. |  |
| 400 | Bad request. | `ErrorResponse` |
| 401 | Unauthorized. | `ErrorResponse` |
| 403 | Forbidden. | `ErrorResponse` |
| 500 | Internal server error. | `ErrorResponse` |

## Example Request

```bash
curl -X GET "https://api.sbx.avalara.com/einvoicing/trading-partners" \
  -H "Authorization: Basic <credentials>" \
  -H "Accept: application/json"
```