COcodatio
Customers

List customers

Changed on

The List customers endpoint returns a list of customers for a given company's connection.

Customers are people or organizations that buy goods or services from the SMB.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/customers

Request

  • Base URL
    https://api.codat.io
  • 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

Success

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

  • c72dd261b9b4Revision changes
    • breaking

      the response property //////// became optional for the status

  • 4bfab0afa6caRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status