Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-054874600.7 KB

3a810b6f9c66

Manage data

Get pull operation

Retrieve information about a single dataset or pull operation.

get/companies/{companyId}/data/history/{datasetId}

Response

OK

idstring uuid required

Unique identifier of the pull operation.

companyIdstring uuid required

Unique identifier of the company associated to this pull operation.

connectionIdstring uuid required

Unique identifier of the connection associated to this pull operation.

dataTypestring required

The data type you are requesting in a pull operation.

status'Initial' | 'Queued' | 'Fetching' | 'MapQueued' | 'Mapping' | 'Complete' | 'FetchError' | 'MapError' | 'InternalError' | 'ProcessingQueued' | 'Processing' | 'ProcessingError' | 'ValidationQueued' | 'Validating' | 'ValidationError' | 'AuthError' | 'Cancelled' | 'NotSupported' | 'RateLimitError' | 'PermissionsError' | 'PrerequisiteNotMet' required

The current status of the dataset.

statusDescriptionstring nullable

Additional information about the dataset status.

errorMessagestring nullable

A message about a transient or persistent error returned by Codat or the source platform.

requested1 required— unresolved $ref
completed1 — unresolved $ref
progressinteger required

An integer signifying the progress of the pull operation.

isCompletedboolean required

True if the pull operation is completed successfully. The isCompleted property is not queryable. To filter failed pull operations, query by status!=Complete&&status!=NotSupported instead.

isErroredboolean required

True if the pull operation entered an error state.

Example response

{
  "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
  "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
  "connectionId": "51baa045-4836-4317-a42e-3542e991e581",
  "dataType": "invoices",
  "status": "Initial",
  "statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
  "requested": "2022-11-14T11:18:37.2798351Z",
  "progress": 10,
  "isCompleted": false,
  "isErrored": false
}