Apis::V4::PeopleSearch API

search people by unassigned

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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDQ3MzIzOSwiaWF0IjoxNzA0NDczMDU5fQ.I8IBJcaDIGpjpw47NMAmb4KneZ4uXsozCxQjQ-zaNRc
Host: example.org
Cookie: 

Route

GET /apis/v4/search?filters[unassigned]=true

Query Parameters

filters={"unassigned"=>"true"}

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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDY0NTg1OSwiaWF0IjoxNzA0NDczMDU5fQ.lxWPR5di0hEaMUpYzcBn5aeYOdcqvVkIWXGP_vGBAWE
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"b31eb387f610c9efd05a5f07e32ff21d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e872a9e6-454f-4f49-973a-8dd5ce2af73a
X-Runtime: 0.080026
Content-Length: 2794

Status

200

Body

Request

Headers

Version: HTTP/1.0
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDQ3MzIzOSwiaWF0IjoxNzA0NDczMDU5fQ.I8IBJcaDIGpjpw47NMAmb4KneZ4uXsozCxQjQ-zaNRc
Host: example.org
Cookie: 

Route

GET /apis/v4/search?filters[unassigned]=false&organization_ids=149

Query Parameters

filters={"unassigned"=>"false"}
organization_ids=149

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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDY0NTg1OSwiaWF0IjoxNzA0NDczMDU5fQ.lxWPR5di0hEaMUpYzcBn5aeYOdcqvVkIWXGP_vGBAWE
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"31f55e6d54cfe39ebdf789b1db0bc726"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1ed5187a-5b95-4c50-8839-2db8a1834b77
X-Runtime: 0.055976
Content-Length: 936

Status

200

Body