---
title: "Get InMail credit balance"
method: GET
path: "/v1/{account_id}/inmail-credits"
tags: ["Users"]
---

# Get InMail credit balance

`GET /v1/{account_id}/inmail-credits`

## Request

- Base URL: `https://api.curviate.com`
- URL: `https://api.curviate.com/v1/{account_id}/inmail-credits`
- Auth: HTTP bearer

Retrieve the remaining InMail credits across the account's subscribed LinkedIn premium products. Each product's balance is null when that product is not subscribed.

## Path parameters

- `account_id` string, required

## Query parameters

- `service` 'classic' | 'recruiter' | 'sales_navigator'

## Response `200`

The account's remaining InMail credits across subscribed LinkedIn premium products. Each product's balance is null when that product is not subscribed.

- object
  - `object` 'inmail_credits', required: Response type discriminator.
  - `credits` object, required
    - `classic` number, nullable, required: Remaining InMail credits on a LinkedIn Premium (classic) subscription, or null if not subscribed.
    - `recruiter` number, nullable, required: Remaining InMail credits on a Recruiter seat, or null if not subscribed.
    - `sales_navigator` number, nullable, required: Remaining InMail credits on a Sales Navigator seat, or null if not subscribed.
  - `safety_warning` SafetyWarning: Present on a successful response when this account crossed an account-safety ceiling while the affected budget row is on the default warn posture. The action still happened. Field-identical to the BUDGET_EXHAUSTED error body except that blocked is false and hint.message describes the outcome, so one branch handles both postures and switching the account to enforce is a configuration change rather than a client rewrite.
    - `row` string, nullable, required: The budget row that breached, for example profile_views or pending_invites. Null when the breach is not about a row: an activity_window warning on an action that spends no budget of its own (editing a message, dismissing a notification, a Recruiter or Sales Navigator admin action) is still governed by the hours the account works in. Read hint.parameter for what to change; whenever this is null it names posture, because the activity window edges are set per action type and this action has none, so the levers that reach it are the account timezone and posture.
    - `reset_at` string, nullable, required: The instant the refusal lifts: the window roll on a ceiling refusal, the next window open on an activity-window one. Null in the two cases no clock frees, the pending_invites gauge and InMail credits (row inmail).
    - `hint` object, required
      - `parameter` string, required: The settable parameter on PATCH /v1/{account_id}/safety-policy.
      - `message` string, required: What the condition is and what changing that parameter would do. This is the one field whose text differs from the BUDGET_EXHAUSTED refusal: here it says the action went through, and on a ceiling breach how far past the ceiling this row now stands, rather than telling you to set posture to warn when it already is. Branch on parameter, reason and blocked, never on this text.
    - `reason` 'ceiling' | 'activity_window', required: Which rule was crossed. ceiling means the row's configured limit is spent; activity_window means the account is outside the hours it works in, which is a different fact with a different remedy. hint.parameter names the right setting for each.
    - `blocked` boolean, required: Always false here. True on the BUDGET_EXHAUSTED refusal carrying the same payload.

## Other responses

- `400`: Invalid service value.
- `401`: Missing or invalid API key.
- `404`: The supplied account_id does not belong to this tenant. An id whose connection was replaced or removed also stops resolving here, and it is already absent from the list, so re-read `GET /v1/accounts` for the current id.
- `429`: Rate limited, slow down and retry after the hinted delay.
- `500`: Internal error.
- `502`: A temporary error occurred. Please try again.
- `503`: Service unavailable.
- `504`: Gateway timeout.

---

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