People

get
Authorizations
AuthorizationstringRequired
Query parameters
searchstringOptional

A search term.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

Page number to retrieve (1-indexed).

page_sizeintegerOptional

Number of results per page. Defaults to the pagination class's page size and respects the configured maximum.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uri · nullableOptional
previousstring · uri · nullableOptional
get
/people/
200Success
post
Authorizations
AuthorizationstringRequired
Body
emailstring · email · min: 1Required
display_namestring · nullableOptional
first_namestring · nullableOptional
last_namestring · nullableOptional
phonestring · nullableOptional
linkedin_urlstring · nullableOptional
websitestring · nullableOptional
companystring · nullableOptional
job_titlestring · nullableOptional
industrystring · nullableOptional
addressstring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
postal_codestring · nullableOptional
countrystring · nullableOptional
slack_member_idstring · nullableOptional
Responses
post
/people/
201Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
namestring · min: 1Read-onlyOptional
first_namestring · min: 1Read-onlyOptional
last_namestring · min: 1Read-onlyOptional
preferred_namestring · min: 1 · nullableRead-onlyOptional
linkedin_urlstring · uri · min: 1 · nullableRead-onlyOptional
phonestring · min: 1 · nullableRead-onlyOptional
primary_work_emailstring · nullableRead-onlyOptional
primary_personal_emailstring · nullableRead-onlyOptional
archivedstring · date-time · nullableRead-onlyOptional
createdstring · date-timeRead-onlyOptional
modifiedstring · date-timeRead-onlyOptional
get
/people/{id}/
200Success

Last updated