Relationship Search

Search for relationships

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

  • Sources and destinations (source_contact, destination_contact, source_company, destination_company) take a reference with equal or not_equal:
    { "source_contact": { "equal": "/v1/contacts/1000" } }
    Use null to match relationships without one, e.g. { "source_contact": { "equal": null } } finds relationships between companies.
  • relationship_type takes a relationship type search filter:
    { "relationship_type": { "any": { "forward": { "equal": "is the parent company of" } } } }
    Use blank or not_blank to find relationships without or with a type.
Query Params
int32
≤ 250
Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

boolean

Return every attribute of each result instead of the short list form.

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params
source_contact
object

Source contact reference, e.g. /v1/contacts/1000. Use null to match relationships without one.

destination_contact
object

Destination contact reference, e.g. /v1/contacts/1001. Use null to match relationships without one.

source_company
object

Source company reference, e.g. /v1/companies/1000. Use null to match relationships without one.

destination_company
object

Destination company reference, e.g. /v1/companies/1001. Use null to match relationships without one.

relationship_type
object

The relationship type. The operand is a relationship type search filter, e.g. {"any": {"forward": {"equal": "is the parent company of"}}}. Use blank or not_blank to find relationships without or with a type.

details
object

Details text

relationship_id
object

The relationship's numeric ID

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json