Get change history for an account

post

https://api.convert.com/api/v2/accounts/{account_id}/change-history

Retrieves a historical log of changes made within the specified account, such as modifications to account settings or billing. This provides an audit trail for account-level activities. The Knowledge Base states, "The Change History shows a record of user activity for each of your projects." This extends to account changes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

Body Params

Filters for retrieving the change history log for an account. Allows specifying date ranges, the user who made changes, types of objects changed (e.g., 'project', 'billing'), and methods of change (API or app UI).

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60. Defaults to 1 if not specified.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

methods

array of objects | null

methods

projects

array of integers | null

List of projects id to get data by

projects

objects

array of objects | null

List of objects to get data by

objects

sort_by

string | null

enum

Defaults to timestamp

A value to sort history list by specific field(s)

Defaults to timestamp if not provided

Allowed:

expand

array of objects | null

Specifies linked objects to expand in the response, e.g., 'project'. Refer to the Expanding Fields section.

expand

Responses

200A log of changes made within an account or project. Each entry details the event (e.g., 'create', 'update', 'delete'), the object changed (e.g., 'experience', 'goal'), object_id, user who made the change, timestamp, and changes (old and new values).

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.