Custom data type

List custom data type records

The List custom data type records endpoint returns a paginated list of records pulled for the specified custom data type you previously configured.

A custom data type is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined Configure custom data type

get/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}
  • 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.

Response

OK

resultsCustomDataTypeRecord[] (unresolved $ref)
pageNumberPageNumber (unresolved $ref)
pageSizePageSize (unresolved $ref)
totalResultsTotalResults (unresolved $ref)

Changes

No recorded changes to this operation across all 72 revisions of this API.