Contacts

Get a contact relation

Retrieves a relation for a specified contact if associated with the authenticated client.

get/contacts/{contactId}/relations/{relatedContactId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/contacts/{contactId}/relations/{relatedContactId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

contactIdstring required
relatedContactIdstring uuid required

Response

When request is successful. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.