Skip to main content
GET
Get record field history

Authorizations

x-api-key
string
header
required

Public API key for the Octolane organization.

Path Parameters

object_type
enum<string>
required

Object collection the record belongs to.

Available options:
accounts,
contacts,
opportunities
object_id
string<uuid>
required

The record ID.

Query Parameters

property_name
string

Restrict history to a single field, identified by its stable property name (for example opportunity_stage).

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:20

Entries per page.

Required range: 1 <= x <= 100

Response

History entries were returned.

success
boolean
Example:

true

message
string
data
object

Endpoint-specific response payload.