Apis::V4::PeopleSearch API

search people by gender

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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDQ3MzIzOCwiaWF0IjoxNzA0NDczMDU4fQ.gM9aMCqMiOPMksL3Xc2J3ZW0eH7viGE601oIe7A1wdY
Host: example.org
Cookie: 

Route

GET /apis/v4/search?filters[gender]=f

Query Parameters

filters={"gender"=>"f"}

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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDY0NTg1OCwiaWF0IjoxNzA0NDczMDU4fQ.qwRzL7DO-rpU__qZJAxRe25sbGqaZtgfiZHDO5oQvRo
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"ead7d26764b8a8a5dddaa952ddeb6f97"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: df0f9020-d971-4ecc-b9e7-2d8f5eff907b
X-Runtime: 0.044315
Content-Length: 1112

Status

200

Body