---
title: "List integrations"
method: GET
path: "/api/v1/integrations"
tags: ["integrations"]
---

# List integrations

`GET /api/v1/integrations`

## Request

- Base URL: `https://app.blueticked.com`
- URL: `https://app.blueticked.com/api/v1/integrations`
- Auth: HTTP bearer

List outbound HTTP integrations, newest first, with cursor pagination.

Filters: `status=` (active | paused | errored) and `business_id=` (must belong to the workspace).

Signing secrets are never returned; `has_secret` tells you whether one is set.

A connection made by signing in to a system from Blueticked (Xero, for example) carries `connector_key`, `connection_state` (pending, connected, expiring, needs_reauth or revoked), `connection_state_since`, `connection_state_reason` in words and `external_account_label`, the company chosen at the vendor. Every other connection reads null for all five. The list leaves out a sign-in that was started and not finished (pending). The vendor's tokens are never returned.

Each item is the full public integration shape: alongside the fields shown it also carries the field/response maps, custom headers, inbound settings, credential/health timestamps and counters. Secret ciphertext and hashes are never included.

## Query parameters

- `status` string
- `business_id` string
- `limit` integer
- `cursor` string

## Response `200`

Success

- object
  - `data` object[], required
    - `organization_id` string, uuid, required
    - `auth_config` object, required
    - `sample_payload` object, required
    - `headers` object, required
    - `field_map` object[], required
      - `source` string, required
      - `target` string, required
      - `required` boolean
      - `fallback` unknown
    - `response_map` object[], required
      - `source` string, required
      - `target` string, required
      - `required` boolean
      - `fallback` unknown
    - `inbound_field_map` object[], required
      - `source` string, required
      - `target` string, required
      - `required` boolean
      - `fallback` unknown
    - `inbound_enabled` boolean, required
    - `credential_updated_at` string, date-time, nullable, required
    - `credential_updated_by` string, nullable, required
    - `inbound_token_hint` string, nullable, required
    - `inbound_last_at` string, date-time, nullable, required
    - `inbound_last_status` 'accepted' | 'rejected' | 'null', nullable, required
    - `inbound_target_channel` 'whatsapp' | 'sms' | 'email' | 'null', nullable, required
    - `last_success_at` string, date-time, nullable, required
    - `last_failure_at` string, date-time, nullable, required
    - `last_delivery_at` string, date-time, nullable, required
    - `last_health_alert_at` string, date-time, nullable, required
    - `last_test_status` 'passed' | 'failed' | 'null', nullable, required
    - `last_test_at` string, date-time, nullable, required
    - `last_error` string, nullable, required
    - `last_response_status` number, nullable, required
    - `id` string, uuid, required
    - `business_id` string, uuid, nullable, required
    - `name` string, required
    - `description` string, nullable, required
    - `kind` 'custom_webhook' | 'booking_api' | 'crm_api' | 'calendar' | 'other', required
    - `status` 'active' | 'paused' | 'errored', required
    - `method` 'POST' | 'PUT' | 'PATCH', required
    - `endpoint_url` string, required
    - `auth_type` 'none' | 'signature' | 'bearer' | 'api_key', required
    - `has_secret` boolean, required
    - `health_status` 'unknown' | 'healthy' | 'degraded' | 'failing', required
    - `success_count` number, required
    - `failure_count` number, required
    - `timeout_ms` number, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `connector_key` string, nullable, required
    - `connection_state` 'pending' | 'connected' | 'expiring' | 'needs_reauth' | 'revoked' | 'null', nullable, required
    - `connection_state_since` string, nullable, required
    - `connection_state_reason` string, nullable, required
    - `external_account_label` string, nullable, required
  - `next_cursor` string, nullable, required
  - `has_more` boolean, required
  - `request_id` string, required

## Other responses

- `400`: Validation failed
- `401`: Unauthorized: missing or invalid API key
- `402`: Insufficient wallet balance
- `403`: Forbidden: scope, plan limit, or suspension
- `404`: Not found
- `409`: Conflict (idempotency-key reuse or resource in use)
- `422`: Understood but refused: the request is well-formed, the action is not permitted for this resource
- `429`: Rate limited
- `500`: Internal error
- `502`: An upstream provider refused or failed the request
- `503`: Channel or send queue unavailable

---

[API](https://skmtc.dev/blueticked/apis/blueticked-api.md) · [All operations](https://skmtc.dev/blueticked/apis/blueticked-api/llms.txt) · [OpenAPI document](https://skmtc.dev/blueticked/apis/blueticked-api/revisions/07132284f4ff?raw)