---
title: "Get contact relations"
method: GET
path: "/contacts/{contactId}/relations"
tags: ["Contacts"]
---

# Get contact relations

`GET /contacts/{contactId}/relations`

## Request

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

Returns a list of relations for a specified contact if associated with the authenticated client.

## Path parameters

- `contactId` string, required

## Response `200`

When request is successful. Returns a paged collection of 'Link' objects.

- LinkPagedCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` Link[], nullable
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

## Other responses

- `403`: When contact with specified id is not associated with authenticated client.
- `404`: When contact with specified id does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)