Audits

List audits

The change history of records visible to you.

Filtered request example — Every change to one deal in the last 30 days, newest first:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/audits.json?conditions[auditable_type]=Deal&conditions[auditable_id]=4521&conditions[audit_added][selection]=last_30&sort=-created_at&per_page=100"
get/audits

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/audits
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

audit_typestring

Change type, e.g. create, update, destroy. __NONE__ matches audits with no type.

auditable_typestring

Record type, e.g. Deal, Person, Company

model_columnstring

Field name that changed

model_value_beforestring
model_value_afterstring

Filters as bracketed query parameters, for example ?conditions[auditable_type]=Deal&conditions[audit_added][selection]=last_7. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.

{
  "auditable_id": 123,
  "user_id": 123,
  "audit_added": "last_30"
}
sortstring

Sort key, - prefix for descending

pageinteger

Page number

per_pageinteger

Records per page, at most 200

Response

Successful Response

Example response

{
  "entries": [
    {
      "auditable_type": "Deal",
      "audit_type": "update",
      "model_column": "deal_stage_id"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.