---
title: "Retrieve settings"
method: GET
path: "/v1/finder/settings"
tags: ["RecruitAffiliates.ai"]
---

# Retrieve settings

`GET /v1/finder/settings`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/settings`
- Auth: HTTP bearer

The plan, the team's seats and the connected inboxes.

**Scope:** `finder:read` (or `finder:write`)

## Response `200`

Settings

- FinderSettings
  - `object` 'finder_settings', required
  - `plan` string, required
  - `trial_ends_at` string, date-time, nullable, required: ISO-8601, UTC
  - `livemode` boolean, required
  - `seats` object, required
    - `used` integer, required
    - `members` integer, required
    - `pending` integer, required
    - `cap` integer, nullable, required
  - `inboxes` FinderInbox[], required
    - `id` string, required: Prefixed id (`fin_…`)
    - `object` 'finder_inbox', required
    - `address` string, required
    - `state` string, required
    - `kind` string, nullable, required
    - `connected_at` string, date-time, required: ISO-8601, UTC
    - `disconnected_at` string, nullable, required
    - `disconnect_reason` string, nullable, required

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

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