Searching

Reference for Smart Searches

/orgs/{org_id}/people/queries

The resource endpoint for the smart searches referenced above.

GET

Returns a list of objects (see below) containing the person query objects, for the organization with the query type “standalone”.

POST

/orgs/{org_id}/people/queries/{query_id}

DELETE

GET

Returns a person query item.

The query item is an object that consists of an id, type, title, info_text and filter_spec. The type is always “standalone” (when retrieved from this endpoint).

The filter_spec consists of an array of filters that are described here.

Example:

{
    "id": "1",
    "type" : "standalone"
    "title": "example"
    "info_text": "some info text"
    "filter_spec":
    [{
        "op": "add"
        "type": "person_data",
        "config": {
            "fields": {
                "first_name": "Clara",
                "last_name": "Zetkin"
            }
        }
    },
    {
        "op": "add"
        "type": "person_tags",
        "config": {
            "condition": "none",
            "tags": [1, 2, 3]
        }
    }]
}

PATCH

/orgs/{org_id}/people/queries/{query_id}/matches

GET

/orgs/{org_id}/people/queries/{query_id}/matches/{person_id}

GET

/search/{data_type}

Search for data globally (access limited).

POST

/orgs/{org_id}/search/{data_type}

The following datatypes are accepted as the parameter data_type:

  • activity
  • callassignment
  • campaign
  • location
  • person
  • personquery
  • survey
  • surveysubmission

POST

The query must be sent as request data on the form

{ "q": "abc123" }

where abc123 is the search string