Across 8 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
person 11
GET
/v2/org/{orgId}/person
Find persons in the organization
findPersons16 params→ 200202400401404
POST
/v2/org/{orgId}/person
Create a person
createPerson4 params→ 201400401404
GET
/v2/org/{orgId}/person/count
Count persons in an org
countPersons7 params→ 200401404
GET
/v2/org/{orgId}/person/count-invite-users
Count persons in the organization available to invite as users
countPersonsWithoutUser3 params→ 200400401404
GET
/v2/org/{orgId}/person/group-by
Find persons in the organization, grouped by an expression
findPersonsGrouped10 params→ 200202400401404
GET
/v2/org/{orgId}/person/query-invite-users
Find persons in the organization to invite as users
findPersonsWithoutUser7 params→ 200202400401404
GET
/v2/org/{orgId}/person/subcounts
Compute top-N + Other subcounts for one or more fields, for persons in the organization
getPersonSubcounts9 params→ 200202400401404
GET
/v2/org/{orgId}/person/total
Compute aggregated totals for persons matching a query
getPersonTotals8 params→ 200202400401404
GET
/v2/org/{orgId}/person/{personId}
Return a particular person by id
getPerson6 params→ 200400404
PATCH
/v2/org/{orgId}/person/{personId}
Update a person
updatePerson5 params→ 204400401404
DELETE
/v2/org/{orgId}/person/{personId}
Delete a person
deletePerson2 params→ 204400401404
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrgCount (5 properties), ResultsData (4 properties), FieldSubcount (3 properties), AccessAction (3 properties). Each schema is shown below with its type and property counts.
AccessAction
object
3 properties1 required
FieldSubcount
object
3 properties2 required
OrgCount
object
5 properties4 required
ResultsAccess
object
2 properties1 required
SubcountsResponse
object
1 property1 required
ResultsData
object
4 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
