Codat · Example Payload

Codat List Pull Operations Example

Unified_API

Codat List Pull Operations Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "list-pull-operations",
  "method": "GET",
  "path": "/companies/{companyId}/data/history",
  "summary": "List pull operations",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Example",
      "example": {
        "results": [
          {
            "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
            "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
            "connectionId": "51baa045-4836-4317-a42e-3542e991e581",
            "dataType": "invoices",
            "status": "Initial",
            "requested": "2022-11-14T11:18:37.2798351Z",
            "progress": 10,
            "isCompleted": false,
            "isErrored": false
          }
        ],
        "_links": {
          "current": {
            "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history"
          },
          "next": {
            "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2"
          }
        },
        "pageNumber": 0,
        "pageSize": 0,
        "totalResults": 0
      }
    }
  ]
}