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.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDU5NjQ4NCwiaWF0IjoxNzU0NTk2MzA0fQ.i-xI3dRUGmZmMtX1zv9xL5N5xCemDaA6srh5teMsfyA
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.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDc2OTEwNCwiaWF0IjoxNzU0NTk2MzA0fQ.Q6xjgIK8B3R7zOlRY7A-9S3YwE7pQotiNffG0ZqcRP8
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"f94ad5c4b99cac7bca31bc4978e390b6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 063f885f-0735-4dd1-9175-cd7cefd2f23d
X-Runtime: 0.052440
Content-Length: 2794

Status

200

Body

Request

Headers

Version: HTTP/1.0
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDU5NjQ4NCwiaWF0IjoxNzU0NTk2MzA0fQ.i-xI3dRUGmZmMtX1zv9xL5N5xCemDaA6srh5teMsfyA
Host: example.org
Cookie: 

Route

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

Query Parameters

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

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.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDc2OTEwNCwiaWF0IjoxNzU0NTk2MzA0fQ.Q6xjgIK8B3R7zOlRY7A-9S3YwE7pQotiNffG0ZqcRP8
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"0a56d3dd05d0ac1fda48fb2b998952fc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b7d3296b-d335-43a6-bf2c-1157c63f8a94
X-Runtime: 0.043679
Content-Length: 936

Status

200

Body