List Sale History

This endpoint returns the change history of a sale, oldest first.

Important Notes

  • Requires sales:read scope.
  • action is create, update or destroy.
  • changes is {field: [before, after]} on update and {field: value} on create and destroy. It only carries fields of the Sale resource; anything else is left out.
  • user_id is the AgendaPro user who made the change, or null when the change had no user. at is UTC.
  • Canceling a sale is the update entry whose changes.status ends in canceled: its user_id is who canceled it and its at is when.
  • A sale of another company, or one that no longer exists, answers 404.

Errors Dictionary

StatusErrorDetailDescription
400invalid_rangepage, per_pagePagination value is not a positive number.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks sales:read scope.
404not_foundsaleSale not found, or it belongs to another company.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Sale unique identifier.

Query Params
integer
≥ 1
Defaults to 1

Page number (defaults to 1).

integer
≥ 1
Defaults to 30

Records per page (defaults to 30).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json