crm_contacts_by_relationship_list
Search contacts by relationship ID with optional filters for name, title, archive, and date ranges. Get a paginated list of matching contacts.
Instructions
Search contact records associated with a known relationship ID, with optional identity, archive, and date filters. Returns one page; use crm_contact_relationships_list to inspect the links owned by one known contact.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by contact name | |
| page | No | Page number (starts at 1) | |
| sort | No | Sort: Field (default), +Field (asc), or -Field (desc). Fields: Id, ModifiedOn, CreatedOn | |
| title | No | Filter by contact title | |
| pageSize | No | Records per page (default 50) | |
| isArchived | No | Filter by archive status | |
| referenceId | No | Filter by external reference ID | |
| includeTotal | No | Include total count in response | |
| createdBefore | No | ||
| modifiedBefore | No | ||
| relationshipId | Yes | Contact relationship ID | |
| createdOnOrAfter | No | ||
| modifiedOnOrAfter | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||