| 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. |
Version: HTTP/1.0 Accept: application/json Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDU5NjQ4NCwiaWF0IjoxNzU0NTk2MzA0fQ.i-xI3dRUGmZmMtX1zv9xL5N5xCemDaA6srh5teMsfyA Host: example.org Cookie:
GET /apis/v4/search?filters[archived]=true
filters={"archived"=>"true"}
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/"c0e069717f7ce21b8a94fa5a6ee97056" Cache-Control: max-age=0, private, must-revalidate X-Request-Id: bee54aa7-7151-4a1c-88bd-db631f44f00d X-Runtime: 0.034637 Content-Length: 1169
200
Version: HTTP/1.0 Accept: application/json Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDcsImV4cCI6MTc1NDU5NjQ4NCwiaWF0IjoxNzU0NTk2MzA0fQ.i-xI3dRUGmZmMtX1zv9xL5N5xCemDaA6srh5teMsfyA Host: example.org Cookie:
GET /apis/v4/search?filters[archived]=any
filters={"archived"=>"any"}
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/"e1a6c1c0ff58d3b0b58903d1b11da794" Cache-Control: max-age=0, private, must-revalidate X-Request-Id: 9dea876e-1464-43e1-b71a-c348d8a3995c X-Runtime: 0.073602 Content-Length: 5028
200