| 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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDQ3MzIzNiwiaWF0IjoxNzA0NDczMDU2fQ.8k88CaCVmWmuVCzKNoozjEU29_FqB0TSOlIY3-lxPas 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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDY0NTg1NiwiaWF0IjoxNzA0NDczMDU2fQ.y-4ApCsevO9XJzpBm_q4_yPas9u10fhHKJV9uZUiC_s Access-Control-Expose-Headers: X-MH-Session ETag: W/"0693d08d9fd4b9b1903538c893710c3e" Cache-Control: max-age=0, private, must-revalidate X-Request-Id: d58e1559-da66-4b5d-9395-07c73231149d X-Runtime: 0.051490 Content-Length: 1169
200
Version: HTTP/1.0 Accept: application/json Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDQ3MzIzNiwiaWF0IjoxNzA0NDczMDU2fQ.8k88CaCVmWmuVCzKNoozjEU29_FqB0TSOlIY3-lxPas 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.eyJ1c2VyX2lkIjoxNzcsImV4cCI6MTcwNDY0NTg1NiwiaWF0IjoxNzA0NDczMDU2fQ.y-4ApCsevO9XJzpBm_q4_yPas9u10fhHKJV9uZUiC_s Access-Control-Expose-Headers: X-MH-Session ETag: W/"6a71180a7a81b5dbe724f7dddf76c624" Cache-Control: max-age=0, private, must-revalidate X-Request-Id: b726332d-e589-4e6b-bbb6-ca7cf16ea2bf X-Runtime: 0.103981 Content-Length: 5028
200