Read connection and import status

GET

/v1/account/connections/{connectionId}

const url = 'https://api.dockt.com/v1/account/connections/con_example';
const options = {
  method: 'GET',
  headers: {'x-dockt-expected-workspace': 'wsp_example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.dockt.com/v1/account/connections/con_example \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dockt-expected-workspace: wsp_example'

Authorizations

bearerAuth
sessionCookie

Parameters

Path Parameters

connectionId

required

Account-owned source connection.

string

Header Parameters

x-dockt-expected-user

Rejects the request with 401 unless the browser session belongs to this auth_user_id. This assertion does not grant authority.

string

>= 1 characters

x-dockt-expected-workspace

Unique Dockt workspace identifier.

Responses

200

Envelope for a single resource response.

application/json

Envelope for a single resource response.

object

object

required

string

Allowed values: single

data

required

Account connection and safe source-import progress. Credentials and runtime lease details are never returned.

object

object

required

string

Allowed values: connection

required

Account-owned source connection.

string

provider

required

string

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

status

required

Known values: draft, active, paused, revoked. New values may appear; preserve unfamiliar values and use a safe fallback.

string

>= 1 characters

access_status

required

Known values: pending, ready, reconnect_required, failed. New values may appear; preserve unfamiliar values and use a safe fallback.

string

>= 1 characters

source_organization_id

required

Any of:

string
null

string

source_organization_name

required

Any of:

string
null

string

credential_owner

required

Any of:

object
null

object

account_type

required

Whether the source login is a dedicated read-only account or a person’s own account. Personal access stops when that person leaves the source organization.

string

Allowed values: dedicated personal

established_by

required

object

type

required

string

Allowed values: account_user api_credential

required

string

email

required

Any of:

string
null

string

established_at

required

ISO 8601 date-time string.

string format: date-time

refresh_minutes

required

integer

sites

required

Array<object>

object

required

string

name

required

string

available

required

False when the latest discovery no longer returned this site. Existing mappings and history remain.

boolean

new_since_review

required

Discovered after the site mappings were last saved. New sites are never mapped automatically.

boolean

first_seen_at

required

ISO 8601 date-time string.

string format: date-time

last_seen_at

required

ISO 8601 date-time string.

string format: date-time

last_discovered_at

required

Any of:

string
null

ISO 8601 date-time string.

string format: date-time

bindings

required

Array<object>

object

object

required

string

Allowed values: source_binding

required

Explicit source-site to Workspace mapping.

string

connection_id

required

Account-owned source connection.

string

workspace_id

required

Unique Dockt workspace identifier.

string

site_id

required

string

site_name

required

string

enabled

required

boolean

sync_status

required

Known values: idle, queued, syncing, succeeded, failed, stopped. New values may appear; preserve unfamiliar values and use a safe fallback.

string

>= 1 characters

last_attempt_at

required

Any of:

string
null

ISO 8601 date-time string.

string format: date-time

last_success_at

required

Any of:

string
null

ISO 8601 date-time string.

string format: date-time

next_sync_at

required

Any of:

string
null

ISO 8601 date-time string.

string format: date-time

worker_count

required

integer

completed_workers

required

integer

last_error

required

Any of:

string
null

string

warnings

required

Array<string>

test_stage

required

Any of:

string
null

string

last_error

required

Any of:

string
null

string

credential_cleanup_pending

required

boolean

created_at

required

ISO 8601 date-time string.

string format: date-time

updated_at

required

ISO 8601 date-time string.

string format: date-time

Example

{
  "object": "single",
  "data": {
    "object": "connection",
    "id": "con_example",
    "status": "draft",
    "access_status": "pending",
    "credential_owner": {
      "account_type": "dedicated",
      "established_by": {
        "type": "account_user"
      },
      "established_at": "2026-08-06T09:30:00Z"
    },
    "sites": [
      {
        "first_seen_at": "2026-08-06T09:30:00Z",
        "last_seen_at": "2026-08-06T09:30:00Z"
      }
    ],
    "last_discovered_at": "2026-08-06T09:30:00Z",
    "bindings": [
      {
        "object": "source_binding",
        "id": "sbn_example",
        "connection_id": "con_example",
        "workspace_id": "wsp_example",
        "sync_status": "idle",
        "last_attempt_at": "2026-08-06T09:30:00Z",
        "last_success_at": "2026-08-06T09:30:00Z",
        "next_sync_at": "2026-08-06T09:30:00Z"
      }
    ],
    "created_at": "2026-08-06T09:30:00Z",
    "updated_at": "2026-08-06T09:30:00Z"
  }
}

400

Problem Details response for HTTP 400. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/invalid-request",
  "title": "Bad request",
  "status": 400,
  "detail": "The request did not match the expected schema.",
  "instance": "req_example1042"
}

401

Problem Details response for HTTP 401. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/missing-auth",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Send a valid bearer token or browser session.",
  "instance": "req_example1042"
}

403

Problem Details response for HTTP 403. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The authenticated principal does not have the required permission.",
  "instance": "req_example1042"
}

404

Problem Details response for HTTP 404. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found in the authenticated scope.",
  "instance": "req_example1042"
}

409

Problem Details response for HTTP 409. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The request conflicts with the current resource state.",
  "instance": "req_example1042"
}

422

Problem Details response for HTTP 422. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/validation",
  "title": "Validation failed",
  "status": 422,
  "detail": "Correct the invalid fields and send the request again.",
  "instance": "req_example1042",
  "errors": {
    "issues": [
      {
        "path": [
          "body",
          "inputs",
          "3",
          "value"
        ],
        "message": "Expected a two-letter country code."
      }
    ]
  }
}

429

Problem Details response for HTTP 429. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/rate-limit",
  "title": "Too many requests",
  "status": 429,
  "detail": "Wait for the Retry-After interval before retrying.",
  "instance": "req_example1042"
}

500

Problem Details response for HTTP 500. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/internal",
  "title": "Internal server error",
  "status": 500,
  "detail": "Retry the request safely or contact Dockt support with the request ID.",
  "instance": "req_example1042"
}

503

Problem Details response for HTTP 503. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "instance": "req_example1042"
}

Read connection and import status

Authorizations

Parameters

Path Parameters

Header Parameters

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

503

Example

Analytics cookies