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
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
get
/people/{id}/
200Success

Last updated