Apis::V4::PeopleSearch API

search people in specific organizations

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also passthis into the Authorization header)
q search string, the system will try to search by first and last name, or email address if you include a '@'
limit max number of people to return. Defaults to 10.
organization_ids (optional) only look in these organizations
fields hash of fields you want for model types. the person type will default to these fields: first_name,last_name,gender,primary_email_address. But you could request picture if you want to receive that as well.

Request

Headers

Version: HTTP/1.0
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDU5NjQ4NSwiaWF0IjoxNzU0NTk2MzA1fQ.icHx1l1HmMJTrvotrO1vhEOI4E1mbe8z5ogXi6FFTKo
Host: example.org
Cookie: 

Route

GET /apis/v4/search?q=Ultr&organization_ids=137%2C135&limit=10

Query Parameters

q=Ultr
organization_ids=137,135
limit=10

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDc2OTEwNiwiaWF0IjoxNzU0NTk2MzA2fQ.Huj7aiR5GyMKW55eWvzzm2l2i7LdOIxJixLzAbrZR4g
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"663cf889ebf819b75ac5f54d8a368969"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fb7a75e7-9a5d-44a2-a221-43088fe45a05
X-Runtime: 0.056444
Content-Length: 3042

Status

200

Body