v1

latestOpenAPI 3.1.02026-08-066484183.6 MB
Reports

Get person reports

Retrieve aggregated person report data grouped by configurable dimensions.

get/api/v2/reports/person_reports

Query parameters

group'approval_policy' | 'autotracking' | 'company' | 'contact_address' | 'contact_city' | 'contact_country' | 'contact_email' | 'contact_phone' | 'contact_state' | 'contact_website' | 'contact_zipcode' | 'created_at' | 'custom_fields' | 'custom_role' | 'deactivated_at' | 'job_role' | 'joined_at' | 'last_activity_at' | 'manager' | 'month' | 'offboarding_status' | 'organization' | 'person' | 'quarter' | 'role_id' | 'shared_seat' | 'status' | 'subsidiary' | 'type' | 'week' | 'year'

Group person report

OR

Filters

{
  "id": {
    "eq": "123"
  }
}
sortstring[]

Sort person report

Headers

X-Organization-Idstring required

Organization ID

Response

Collection person report