COcodatio
Push data

List push operations

Changed on

The List push operations endpoint returns a list of push operations performed on the company.

Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.

get/companies/{companyId}/push

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/push
  • Auth
    API key in header Authorization

Query parameters

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring
Example:-modifiedDate

Field to order results by. Read more.

Response

OK

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required(unresolved $ref)

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

  • bff9b9776ecfRevision changes
    • breaking

      the /// response's property type changed from no type to string, and format from no format to uuid for status

  • 1834c78d88a5Revision changes
    • breaking

      the /// response's property type changed from string to no type, and format from uuid to no format for status