# Search integrations

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/setting/external_integration/filter
```

- API version: v1
- Operation ID: `v1_public_external_integration_filter`
- Section: Team settings › [Integrations](https://developer.yoprint.com/reference/integrations.md)
- Web page: https://developer.yoprint.com/reference/integrations/v1-external-integration-filter/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns the team's integrations that match `filters`, a page at a time (the team's page size, 50 by default). Each filter is `{key, operator, value}`:

- `label`, `type`, `sub_type` (the answers' `subtype`), `status`: text, with `eq`, `neq`, `ct` (contains), `sw` (starts with) or `ew` (ends with).
- `trashed_only`: `true` or `false`, with `eq` or `neq`, to list deleted integrations.

Shopify stores are left out when your plan doesn't include Shopify. It changes nothing, but as a POST it needs Manage Settings.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `filters` (array of objects, optional): At least 1 item.
  - Each item:
    - `key` (string, required): One of: `"trashed_only"`, `"label"`, `"type"`, `"sub_type"`, `"status"`.
    - `operator` (string, required): One of: `"eq"`, `"neq"`, `"ct"`, `"sw"`, `"ew"`.
    - `value` (string | boolean, required)
- `sort` (array of objects, optional): Optional sort.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/external_integration/filter' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": [
      {
        "key": "type",
        "operator": "eq",
        "value": "supplier"
      }
    ]
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `deprecated` (boolean, required): A retired integration: it can only be deleted.
    - `has_logs` (boolean, required): Whether it keeps a log of sync errors: true for QuickBooks Online only.
    - `id` (string, required)
    - `label` (string, required)
    - `status` (string, required): For example `ENABLED`, `ACTION_REQUIRED`, `REAUTH` (sign in to the provider again), `UNINITIALIZED` (set up but not configured yet) or `DISABLED`.
    - `subtype` (string, required): Which integration, for example `sanmar_v1`. The same value goes in the create path.
    - `trashed` (boolean, required)
    - `type` (string, required): The kind: `supplier`, `sms` (Twilio), `shipment_v1` (GoShippo), `data_sync` (QuickBooks Online, Shopify), `payment_gateway` (Square), `shipment` (retired FedEx and UPS). One of: `"supplier"`, `"sms"`, `"shipment_v1"`, `"data_sync"`, `"payment_gateway"`, `"shipment"`.
    - `data` (object | array | null, optional)
    - `integration_check_key` (string, optional): A fixed key for the kind of integration, such as `sanmar` or `shopify`.
    - `last_sync` (string (date-time) | null, optional)
    - `last_token_refresh` (string (date-time) | null, optional)
    - `option` (object | array | null, optional): The integration's settings, which differ by type.
    - `shopify_admin_app_url` (string | null, optional): Shopify only.
    - `shopify_admin_settings_apps_url` (string | null, optional): Shopify only: the store's apps settings page, where the app is uninstalled.
    - `shopify_admin_url` (string | null, optional): Shopify only: the YoPrint app in the store's Shopify admin. Same as `shopify_admin_app_url`.
    - `shopify_compliance_deletion` (object | null, optional): Shopify only: where a store data deletion requested by Shopify stands, or null.
- `status` (integer, required)
- `success` (boolean, required)
- `pagination` (object, optional)
  - `count` (integer, required)
  - `currentPage` (integer, required)
  - `links` (object | array of any, required): Links to the neighbouring pages: `previous` and `next`, each present only when that page exists. An empty list, `[]`, when there is only one page.
    - `next` (string (uri), optional): The next page.
    - `previous` (string (uri), optional): The previous page.
  - `perPage` (integer, required)
  - `total` (integer, required)
  - `totalPages` (integer, required)

Example response:

```json
{
  "data": [
    {
      "data": [],
      "deprecated": false,
      "has_logs": false,
      "id": "d9ZxWgBz09mDFq",
      "integration_check_key": "sanmar",
      "label": "SanMar Integration",
      "last_sync": null,
      "last_token_refresh": null,
      "option": [],
      "status": "ENABLED",
      "subtype": "sanmar_v1",
      "trashed": false,
      "type": "supplier"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A filter has an unknown `key`, or a value or operator that doesn't fit it (`validation_failed`). Fix: Use the keys and operators listed above.

## Related

- [List integrations](https://developer.yoprint.com/reference/integrations/v1-external-integration-index.md): `GET /v1/api/store/{team_slug}/setting/external_integration`