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

3a810b6f9c66

Push operations

Get push operation

Retrieve push operation.

get/companies/{companyId}/push/{pushOperationKey}

Response

OK

changesPushOperationChange[] nullable— unresolved $ref

Contains a single entry that communicates which record has changed and the manner in which it changed.

dataTypeDataType — unresolved $ref
companyIdSchema required— unresolved $ref
pushOperationKeystring uuid required

A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.

dataConnectionKeySchema required— unresolved $ref
requestedOnUtc1 required— unresolved $ref
completedOnUtc1 — unresolved $ref
timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required— unresolved $ref
errorMessagestring nullable

A message about the error.

validationValidation — unresolved $ref
statusCodeinteger required

Push status code.