API Reference / Contacts

GET /contacts/{contact_id}/relationships

Get all relationships for a specific contact

Returns the relationships this contact is part of. Each one is a single record naming both contacts, with the variant label that applies to each end. Filter by relationship_type_id or narrow to a specific pair.

Path parameters

Name Type Description
contact_id req string Contact ID
Query parameters (14)
Name Type Description
relationship_type_id string Return relationships of a specific type
contact_id_filter string Return relationships in which the provided contact participate
variant_id_filter string Return relationships in which the provided variant participate
search string Search relationships by contact name or relationship-variant name
symmetrical boolean Filter only symmetrical/non-symmetrical relationship types
date_filter string Signals which date field to be used for only returning resources, added or edited, in a specified date range (only to be used with `since` and/or `until`, not with `modified_since` or `unmodified_since`)
since string Specifies the start of the date range to filter resources, which have been added or edited (use with `date_filter` - date must be in format `YYYY-MM-DD` or UNIX timestamp)
until string Specifies the end of the date range to filter resources, which have been added or edited (use with `date_filter` - date must be in format `YYYY-MM-DD` or UNIX timestamp)
modified_since string Return only resources that were modified since specified time (cannot be used with `date_filter` - date must be in format `YYYY-MM-DD` or UNIX timestamp)
unmodified_since string Return only resources that were unmodified since specified time (cannot be used with `date_filter` - date must be in format `YYYY-MM-DD` or UNIX timestamp)
sort_by string Specify field by which to order the results (use in conjunction with `order`)
order string Specify the order (ascending or descending) of the sort of the results (use in conjunction with `sort_by`)
page integer Page number. Starts from 1. Default is 1.
per_page integer Number of records to return. Maximum 100 allowed. Default is 10.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • relationshipsarray<object>
      array item fields →
      • relationshipobject

        The relationship mapping between contacts

        object fields →
        • idstringbson-id

          ID of the relationship

        • relationship_type_idstringbson-idrequired

          ID of the relationship type

        • related_contactsarray<object>required

          The contacts participating in the relationship along with their associated variant names

          array item fields →
          • variant_idstringbson-id

            ID of the relationship variant

          • variant_namestring

            The name of the variant

          • contact_idstringbson-id

            ID of the contact

          • first_namestring

            The first name of the contact

          • last_namestring

            The last name of the contact

          • photo_urlstring

            URL of the contact’s photo

          • company_idstringbson-id

            ID of the company, to which the contact belongs

          • company_namestring

            Name of the company, to whom the contact belongs

          • owner_idstringbson-id

            ID of the user, to whom the contact belongs

        • created_atstringdate-time

          Creation time of the relationship

        • modified_atstringdate-time

          Last modification time of the relationship

    • total_countintegerint32

      Total number of items

    • pageintegerint32

      Current page number

    • per_pageintegerint32

      Number of items returned in each page

    • max_pageintegerint32

      The page number of the last page of items

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides