---
title: "Read the partner account, capabilities and usage"
method: GET
path: "/account"
tags: ["Partner"]
---

# Read the partner account, capabilities and usage

`GET /account`

## Request

- Base URL: `https://app.pumpgtm.com/api/partner/v1`
- URL: `https://app.pumpgtm.com/api/partner/v1/account`
- Auth: HTTP bearer

Partner id and name; enterprise capabilities enabled by PumpGTM (outreach, linkedinConnect); hosted connect-link settings; the REST policy for this key (rest.requireUserHeader); the MCP URL template; active user count; this period's leads, free allowance and billing state.

## Response `200`

Successful response. Read outcome fields; success does not imply delivery.

- object
  - `partner` object, required
    - `id` string, uuid, required
    - `name` string, required
  - `enterprise` object, required
    - `outreach` boolean, required
    - `linkedinConnect` boolean, required
  - `linkedinConnect` object, required
    - `successRedirectUrl` string, nullable, required
    - `failureRedirectUrl` string, nullable, required
    - `brandName` string, nullable, required
  - `rest` object, required
    - `requireUserHeader` boolean, required: When true, every /api/v1 request made with this partner key must carry X-PumpGTM-User; without it the request is 400 user_header_required instead of acting on the partner workspace. Default false.
  - `mcpUrlTemplate` string, required
  - `users` integer, required
  - `accounts` object, required
    - `connected` integer, required
    - `included` integer, nullable, required
    - `remaining` integer, nullable, required
  - `periodStart` string, required
  - `leadsThisPeriod` integer, required
  - `freeLeads` integer, required
  - `freeLeadsRemaining` integer, required
  - `billing` object, required
    - `status` 'metered' | 'billing_required' | 'free', required
    - `checkoutUrl` string, nullable, required

## Other responses

- `400`: Invalid input; for partner keys also user_header_required when the account requires X-PumpGTM-User
- `401`: Missing, invalid or revoked key
- `403`: Workspace mismatch, channel or feature disabled; for partner keys also enterprise_required and user_disabled
- `404`: Resource unavailable in this workspace
- `409`: Revision, identity or state conflict: { error, message } and nothing changed
- `429`: Rate limit; respect Retry-After when provided
- `500`: internal_error: an unexpected failure on our side; retry, then contact PumpGTM
- `503`: Dependency unavailable; identity may be unknown

## Changes

- **2026-10-12** `06d2e4d0e84b`: 8 info
  - the response property `error` became required for the status `400`
  - the response property `error` became required for the status `401`
  - the response property `error` became required for the status `403`
  - the response property `error` became required for the status `404`
  - …4 more
- **2026-10-12** `08c80059d483`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/changes/account/get.md)

---

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