Sign in
Items

List items

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

Items allow your customers to save and track details of the products and services that they buy and sell.

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

get/companies/{companyId}/data/items

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

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

Changes