---
title: "Get an integration"
description: "One integration's status, as in GET /account/integrations. id is one of: klaviyo, postscript, shopify_flow, judgeme, smile, gorgias, omnisend, mailchimp, meta_pixel, split_order, shopify_customers."
url: https://docs.stoqapp.com/v2-reference/account-integrations/get-an-integration/
api: "API v2 reference"
method: GET
path: "/account/integrations/{id}"
---

# Get an integration

`GET https://app.stoqapp.com/api/v2/external/account/integrations/{id}`

One integration's status, as in [`GET /account/integrations`](https://docs.stoqapp.com/v2-reference/account-integrations/list-integrations/). id is one of: klaviyo, postscript, shopify_flow, judgeme, smile, gorgias, omnisend, mailchimp, meta_pixel, split_order, shopify_customers.

**Note:** A step with an action names the endpoint that runs it. After the merchant connects or saves a key in the dashboard, read this again to see the result.

## Path parameters

- `id` (string, required): The integration, by the id [`GET /account/integrations`](https://docs.stoqapp.com/v2-reference/account-integrations/list-integrations/) lists (klaviyo, postscript …).

## Returns

The [integration object](https://docs.stoqapp.com/v2-reference/account-integrations/).

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/account/integrations/string" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "id": "string",
  "name": "string",
  "category": "string",
  "used_for": [
    "string"
  ],
  "status": "string",
  "reason": {
    "code": "string",
    "message": "string"
  },
  "connection": {
    "method": "string",
    "connected": true,
    "legacy": true,
    "key_hint": null
  },
  "connect": {
    "pending": true,
    "expires_at": null,
    "last_result": null,
    "last_result_at": null
  },
  "selected_for": [
    null
  ],
  "plan": {
    "required": "string",
    "available": true
  },
  "steps": [
    {
      "id": "string",
      "state": "string",
      "required": true,
      "blocked_by": "string"
    }
  ],
  "settings": {
    "account": null,
    "sidebar_ready": true,
    "sync_customers": true,
    "profile_tag": "string",
    "flows": {
      "restock": {
        "email": null,
        "sms": null
      },
      "wishlist_reminder": {
        "email": null,
        "sms": null
      },
      "preorder": {
        "email": null,
        "sms": null
      },
      "signup_thank_you": {
        "email": null,
        "sms": null
      }
    }
  },
  "actions": [
    "string"
  ],
  "links": {
    "dashboard_url": "string",
    "help_url": "string"
  },
  "recent_events": [
    null
  ]
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

