API Reference / Contacts

GET /contacts/{contact_id}/relationships/{relationship_id}

Get a specific relationship

Returns one relationship for this contact, naming both parties and the variant label at each end. The contact in the path must be one of the two parties, otherwise the request is rejected as invalid.

Path parameters

Name Type Description
contact_id req string Contact ID
relationship_id req string Relationship ID

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object 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

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

Related guides