Account

Create an API key

Changed on Oct 20, 2026

A key never gets more scopes, a higher daily cap, or a higher approval threshold than the key that creates it. Omitted scopes copy the caller. Do not put account:manage or billing:manage on an agent key. Set customer_id to bind the key to one customer. approval_threshold_credits null or omitted means no HTTP threshold and 500 credits on MCP. approval_threshold_enrollments null or omitted means no HTTP threshold and 25 scheduled enrollments on MCP. The key pins the RecruitMCP-Version sent with this request, or the current version.

Scope: account:manage. Acts on the account; keys bound to a customer are refused.

post/v1/api-keys

Request

Base URL: https://api.recruitmcp.com
URL: https://api.recruitmcp.com/v1/api-keys
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://recruitmcp.com/oauth/authorize, token URL https://recruitmcp.com/oauth/token, scopes: account:manage)

Headers

Idempotency-Keystring

Optional on this route. At most 128 characters. When present, the same key and body replays the first response for 24 hours. A different body is 409 idempotency_key_reused. A second call waits for the first and replays it. Omit the header to run the request normally.

RecruitMCP-Version'2026-10-13'

API version. Defaults to the version the key was created with. Supported: 2026-10-13.

Request body

namestring

scopesstring[]

Default: every scope of the calling key.

daily_cap_creditsnumber nullable

Credits this key may spend per UTC day.

approval_threshold_creditsinteger nullable

Search, profile, company, and contact calls above this estimate return approval_required. Null means unset.

approval_threshold_enrollmentsinteger nullable

An enrollment whose summary.scheduled is above this returns approval_required. Null means unset.

customer_idstring nullable

expires_atstring date-time nullable

Response

Created. The secret is shown once.

idstring required

object'api_key' required

namestring nullable

prefixstring required

kind'secret' | 'oauth'

scopesstring[] required

customer_idstring nullable

Keys bound to a customer always act inside it.

daily_cap_creditsinteger nullable

approval_threshold_creditsinteger nullable

Null when unset. HTTP then has no threshold. MCP uses 500 credits.

approval_threshold_enrollmentsinteger nullable

Null when unset. HTTP then has no enrollment threshold. MCP uses 25 scheduled enrollments.

api_versionstring

Pinned RecruitMCP-Version.

created_atstring date-time required

last_used_atstring date-time nullable

expires_atstring date-time nullable

api_keystring required

The secret. Shown once.

Example response

{
  "id": "key_1a2b3c4d5e6f7a8b9c",
  "object": "api_key",
  "name": "n8n production",
  "prefix": "rmcp_live_ab12",
  "kind": "secret",
  "scopes": [
    "sourcing:read",
    "sourcing:spend"
  ],
  "customer_id": null,
  "daily_cap_credits": 50,
  "approval_threshold_credits": null,
  "approval_threshold_enrollments": null,
  "api_version": "2026-10-13",
  "created_at": "2026-10-13T09:00:00Z",
  "last_used_at": null,
  "expires_at": null
}

Changes

Oct 20, 2026ad27b35513a6 Revision changes
- warning
  added the new approval_forced enum value to the / response property for the response status
- warning
  added the new approval_forced enum value to the / response property for the response status
- warning
  added the new approval_forced enum value to the / response property for the response status
- warning
  added the new approval_forced enum value to the / response property for the response status

Operation history