Skip to content

List the integrations

GET
/integrations
curl --request GET \
--url 'https://api.connectato.com/v1/integrations?sort=created_at' \
--header 'Authorization: Bearer <token>'

Scope: read_integrations.

The organization’s connected apps: stores, courier and invoicing accounts, email and SMS providers, disconnected ones included (status disconnected), so a client syncing by updated_since sees an account removed. filter[status][is_not]=disconnected keeps the installed ones.

limit
integer
>= 1 <= 200

Items per page. Default: 50.

cursor
string

The previous page’s next_cursor, with the same filter, sort and updated_since.

sort
string
Allowed values: created_at name updated_at -created_at -name -updated_at

The order; - before a key for descending. Default: -created_at.

updated_since
string format: date-time

Only what changed at or after this moment (RFC 3339), read in sort=updated_at.

filter[category]
Array<string>
Allowed values: store courier invoicing email sms

One or more codes, comma-separated (filter[category]=a,b), or filter[category][is_not]=a,b for the others.

filter[vendor]
Array<string>

One or more of the organization’s own codes, comma-separated (filter[vendor]=a,b), or filter[vendor][is_not]=a,b for the others.

filter[status]
Array<string>
Allowed values: connected paused needs_reauth error disabled disconnected

One or more codes, comma-separated (filter[status]=a,b), or filter[status][is_not]=a,b for the others.

A page of the list.

Media typeapplication/json
object
data
required
Array<object>
IntegrationResource
object
id
required

The integration’s public id (int_...).

string
/^int_[0-9a-z]{26}$/
category
required

What it is used for: store (orders come from it), courier (AWBs, labels, tracking), invoicing (invoices), email or sms (messages to customers). New values may appear: treat one you do not know as such.

string
vendor
required

The vendor’s code: shopify, woocommerce, sameday, fancourier, smartbill, …; test_store, test_courier and test_invoicing are test integrations, connected only in a test organization. A partner’s app installed in the organization is its own vendor: its app id (app_...), as in app_id.

string
/^app_[0-9a-z]{26}$/
app_id
required

The partner app this integration is, installed in the organization (app_...); null for a Connectato integration.

string | null
/^app_[0-9a-z]{26}$/
name
required

The name the merchant gave this connection; tells two accounts of one vendor apart.

string
status
required

connected (working); paused (by the merchant, nothing runs); needs_reauth, error, disabled (the merchant must connect it again); disconnected (removed by the merchant, kept so records still name it). New values may appear: treat one you do not know as such.

string
account
required

The vendor-side account it is connected to (a Shopify shop domain, a WooCommerce store URL); null when the vendor has none.

string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
next_cursor
required

The next page’s cursor; null on the last page.

string | null

Example generated

{
"data": [
{
"id": "example",
"category": "example",
"vendor": "example",
"app_id": "example",
"name": "example",
"status": "example",
"account": "example",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
],
"next_cursor": "example"
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

No valid access token.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

WWW-Authenticate
string

Bearer: send an access token as a Bearer token.

The app was not granted the scope (insufficient_scope).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Validation failed (validation_failed, errors per field): an unknown filter, value or sort, a limit out of range, a malformed updated_since, or a cursor of another query.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Too many requests: retry after Retry-After seconds.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Retry-After
integer

Seconds to wait before retrying.