Skip to main content
GET
/
contacts
/
{contactId}
/
relations
/
{relatedContactId}
Get a contact relation
curl --request GET \
  --url https://api.smokeball.com/contacts/{contactId}/relations/{relatedContactId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
contactId
string
required
ā€‹
relatedContactId
string<uuid>
required

Response

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

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET