List integrations

GET/v1/api/store/{team_slug}/setting/external_integration

v1Operation ID v1_public_external_integration_index

Returns the team's integrations: suppliers, Twilio, GoShippo, QuickBooks Online, Square and Shopify. In the web app they are under Settings > Apps.

Each shows its type, subtype, label and status. Check status before relying on one: REAUTH means someone has to sign in to the provider again. (Answers call it subtype; the Search filter key is sub_type.) Shopify stores appear only when your plan includes Shopify. Retired integrations (FedEx, UPS, AlphaBroder, Delta Apparel) are left out; find them with "Search integrations". A removed Shopify store still waiting to be deleted is included, with trashed: true.

Supplier passwords are not in this list. For one integration's settings, get it by id.

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. AI apps (MCP connections) need Manage Settings to read it.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (17)

  • deprecatedbooleanrequired

    A retired integration: it can only be deleted.

  • has_logsbooleanrequired

    Whether it keeps a log of sync errors: true for QuickBooks Online only.

  • idstringrequired
  • labelstringrequired
  • statusstringrequired

    For example ENABLED, ACTION_REQUIRED, REAUTH (sign in to the provider again), UNINITIALIZED (set up but not configured yet) or DISABLED.

  • subtypestringrequired

    Which integration, for example sanmar_v1. The same value goes in the create path.

  • trashedbooleanrequired
  • typestringrequired

    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"
  • dataobject | array | null
  • integration_check_keystring

    A fixed key for the kind of integration, such as sanmar or shopify.

  • last_syncstring (date-time) | null
  • last_token_refreshstring (date-time) | null
  • optionobject | array | null

    The integration's settings, which differ by type.

  • shopify_admin_app_urlstring | null

    Shopify only.

  • shopify_admin_settings_apps_urlstring | null

    Shopify only: the store's apps settings page, where the app is uninstalled.

  • shopify_admin_urlstring | null

    Shopify only: the YoPrint app in the store's Shopify admin. Same as shopify_admin_app_url.

  • shopify_compliance_deletionobject | null

    Shopify only: where a store data deletion requested by Shopify stands, or null.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

Related

• GETGet an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• POSTConnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• POSTSearch integrations/v1/api/store/{team_slug}/setting/external_integration/filter

Example request

curl

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

Example response 200

Response

{
  "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"
    }
  ],
  "status": 200,
  "success": true
}