Search People
POST {{baseUrl}}/organization/v1/people/search
Perform a search for a Person
, by providing search Criteria
in the request body.
May return multiple people depending on the criteria provided.
Request Body
{"0"=>{"operation"=>"eq", "property"=>"lastName", "values"=>["", ""]}, "1"=>{"operation"=>"eq", "property"=>"lastName", "values"=>["", ""]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Api-Key | string | (Required) Added as a part of security scheme: apiKey | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":[{"firstName":"","lastName":"","personId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","customPersonId":"","email":"user@example.com","jobTitle":"","startDate":"1979-09-03","middleName":"","suffix":"","birthDate":"1964-09-25","ssn":"","archiveStatus":false,"archiveDateTime":"1996-05-01T17:19:03.927Z","billCode":"","billReference":""},{"firstName":"","lastName":"","personId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","customPersonId":"","email":"user@example.com","jobTitle":"","startDate":"2012-07-13","middleName":"","suffix":"","birthDate":"1982-03-28","ssn":"","archiveStatus":false,"archiveDateTime":"2013-12-26T14:27:48.207Z","billCode":"","billReference":""}],"meta":{"totalPages":-52812165,"totalRecords":-41071735},"links":{"self":"voluptate exercitation ipsum","first":"amet sit dolor","prev":"irure e","next":"aute","last":"Ut culpa"}}