items list
GET {{baseUrl}}/items
Returns a list of Item
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
company_id | string | If provided, will only return items for this company. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"d2f972d0-2526-434b-9409-4c3b468e08f0","remote_id":"12374","name":"Pickleball Paddle","status":"ACTIVE","unit_price":10,"purchase_price":25,"purchase_account":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","sales_account":"3872b4c9-f5d2-4f3b-a66b-dfedbed42c49","remote_updated_at":"2020-03-31T00:00:00Z"},{"id":"d2f972d0-2526-434b-9409-4c3b468e08f0","remote_id":"12374","name":"Pickleball Paddle","status":"ARCHIVED","unit_price":10,"purchase_price":25,"purchase_account":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","sales_account":"3872b4c9-f5d2-4f3b-a66b-dfedbed42c49","remote_updated_at":"2020-03-31T00:00:00Z"}]}