integrations

List integrations

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.

get/api/v1/integrations

Request

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

Query parameters

statusstring

Filter by status.

business_idstring

Filter by business_id.

limitinteger

Maximum number of items to return.

cursorstring

Opaque pagination cursor. Pass the next_cursor from a previous response; do not construct it yourself.

Response

Success

next_cursorstring nullable required
has_moreboolean required
request_idstring required

Example response

{
  "data": [
    {
      "last_delivery_at": "2026-07-02T10:15:00.000Z",
      "id": "75cafe56-e3f9-4253-8f2b-c51090d65540",
      "business_id": "22222222-2222-4222-9222-222222222222",
      "name": "Booking CRM",
      "endpoint_url": "https://api.example.com/blueticked/hook",
      "has_secret": true,
      "success_count": 42,
      "timeout_ms": 10000,
      "created_at": "2026-07-01T08:00:00.000Z",
      "updated_at": "2026-07-02T10:15:00.000Z"
    }
  ],
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.