# Get an integration

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

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

Returns one integration with its settings. What comes back depends on the type:

- Suppliers add the account they are connected with: `user` (and `account_number` for SanMar). AS Colour adds only `email`. Supplier passwords and AS Colour's API key are never returned.
- Twilio adds `selected_phone_number`, `sms_not_supported_msg` and `webhook_url`. The stored Account SID and auth token are never returned.
- GoShippo adds `webhook_url`, `label_size`, `shipping_phone_number`, the allowed `valid_label_size` values and `carrier_enum`. `goshippo_token` is always null: the stored GoShippo sign-in is never returned.
- QuickBooks Online and Square put their settings in `option`. A QuickBooks `option.setting.payment_deposit_account_id.value` reads `""` (let QuickBooks decide) until one is chosen, and `sync_invoice_payment` reads false while `sync_invoice` is off. Shopify adds links to the store's Shopify admin.

A retired integration answers 422 `integration_deprecated`: delete it.

## Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `external_integration_reference` (string, required): The integration, from the integration list. Its hash id from an earlier answer; there is no unique key for it. Example `d9ZxWgBz09mDFq`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/external_integration/d9ZxWgBz09mDFq' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `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)

Example response:

```json
{
  "data": {
    "account_number": "123456",
    "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",
    "user": "YOUR_SUPPLIER_USERNAME"
  },
  "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`.
- `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.
  - When: No integration of your team has this id. `error.code` is null; `error.message` names the record type. Fix: Use an id from the list.
- `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: `error.code` is `integration_deprecated` (retired), `plan_limitation` (Shopify is not in your plan), or `integration_reauth` (GoShippo or Square needs signing in again). Fix: Delete a retired one; reconnect GoShippo or Square in Settings > Apps.
  - When: Square: `integration_offline` (Square can't be reached), or `integration_transfer_pending` (this Square account is connected to another YoPrint team; `error.connected_team_name` names it and `error.same_name` says whether the two team names match). Fix: Try again later, or confirm the move with the `transfer_confirm` action.
  - When: Shopify: `integration_uninitialized` (its default addresses and warehouse aren't set yet). Fix: Set them with "Update an integration".

## Related

- [Update an integration (same as PUT)](https://developer.yoprint.com/reference/integrations/v1-external-integration-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}`
- [List integrations](https://developer.yoprint.com/reference/integrations/v1-external-integration-index.md): `GET /v1/api/store/{team_slug}/setting/external_integration`