Customers

List customers

Changed on

Customers are sub-workspaces for platforms that serve their own clients. Each has its own seen register, lists, suppressions, and daily cap; credits come from your account.

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

get/v1/customers

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/customers
  • 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:read)

Query parameters

external_idstring

Only the customer with this external_id.

limitinteger

How many items to return. Default 25, at most 100.

cursorstring

next_cursor from the previous response. An invalid cursor is 400 invalid_request, message Invalid cursor.

Headers

RecruitMCP-Version'2026-10-13'

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

Response

Customers, newest first.

object'list' required
next_cursorstring nullable required

Pass as cursor for the next page. Null on the last page.

has_moreboolean required

Example response

{
  "data": [
    {
      "id": "cus_8d1f0a2b3c4d5e6f7a",
      "object": "customer",
      "name": "Northwind Recruiting",
      "external_id": "tenant_42",
      "metadata": {
        "plan": "pro"
      },
      "daily_cap_credits": 100,
      "status": "active",
      "created_at": "2026-10-13T09:00:00Z",
      "updated_at": "2026-10-13T09:00:00Z"
    }
  ]
}

Changes

  • ad27b35513a6Revision 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