Get contacts from group

This endpoint allows API users to get the contacts in a contact group.

get/v2/crm/groups/{group_id}/contacts

Request

Path parameters

ID of the group

Query parameters

Format: sort[last_interaction_at]="desc". Allowed values: asc for ascending order, desc for descending order.

Format: `filters=[{"owners":{"type":IN,"value":["e62e1fd42f3bfe4646c29e1aca535de5218c40be"]}}]

Format: filters=[{"shared_with_me":{"type":"=","value":"true"}}]

Format: filters=[{"_OR":[{"email":{"type":"like","value":"%value%"}},{"first_name":{"type":"like","value":"%value%"}},{"last_name":{"type":"like","value":"%value%"}},{"full_name":{"type":"like","value":"%value%"}}]}]

Format: filters=[{"_OR":[{"interaction":{"type":">","value":1652965774}},{"company":{"type":"=","value":"Best company"}}]}]

Format: filters=[{"interaction":{"type":">","value":1652918152}, "company":{"type":"=","value":"Best company"}}]

Filter by interaction before. Format: filters=[{"interaction":{"type":"<","value":1652918152}}]

Filter by interaction after. Format: filters=[{"interaction":{"type":">","value":1652918152}}]

Filter out users without a company. Format: filters=[{"company":{"type":"!=","value":"Best company"}}]

Filter by company. Format: filters=[{"company":{"type":"=","value":"Best company"}}]

Filter by contact last name. Format: filters=[{"full_name":{"type":"like","value":"value"}}]

Filter by contact last name. Format: filters=[{"last_name":{"type":"like","value":"value"}}]

Filter by contact first name. Format: filters=[{"first_name":{"type":"like","value":"value"}}]

Filter by email. Format: filters=[{"email":{"type":"=","value":"crm@email.com"}}]

How many search items to view per page. Allowed values: positive integers from 1 to 100.

How many pages to fit the results in. Allowed values: any positive integer starting from 1.

Response

List of contacts in the group.

Changes

No recorded changes to this operation across all 1 revision of this API.