Get a contact relation

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

GET /contacts/{contactId}/relations/{relatedContactId}

Get a contact relation

cURL

curl --request GET \
  --url https://api.smokeball.com/contacts/{contactId}/relations/{relatedContactId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

contactId · string · required

relatedContactId · string<uuid> · required

Response

200

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET