> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Create API key > Mint an API key and return the secret beside the item as the envelope's plaintext_token EXACTLY ONCE: hand it to the user at once, never log or echo it; if lost, rotate. permissions must sit inside the issuer's own grant (403 grant_exceeds_ceiling; * only from an unrestricted issuer). expires_at omitted = three years, null = perpetual. Natural key (team, name) among live keys (an expired or revoked key frees its name): a duplicate answers already_exists with the existing key and NO secret. Contract: - MCP tool `create_api_key`, registry package `mcp.id/api_keys`, mount `id.access`. - Operation `create`, response envelope `create`. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API. ## OpenAPI ````yaml /api-reference/id/openapi.yaml post /api/api-keys openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.id' description: >- The identity service: the signed-in account, its workspaces and their members, the sessions and the gtm-api workspaces a team reaches; the API keys, OAuth clients and standing consents; the Paddle billing of the pool a buyer holds (catalog, subscriptions, transactions, payment methods); the partner's surface (white label brands, their clients, the shares handed to workspaces, the certificates behind the brand domains); and the notification feed. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.id`, 88 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/id/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: api_keys description: Registry package `mcp.id/api_keys`, served on MCP mount `id.access`. - name: billing_payment_methods description: >- Registry package `mcp.id/billing_payment_methods`, served on MCP mount `id.billing`. - name: billing_products description: >- Registry package `mcp.id/billing_products`, served on MCP mount `id.billing`. - name: billing_subscriptions description: >- Registry package `mcp.id/billing_subscriptions`, served on MCP mount `id.billing`. - name: billing_transactions description: >- Registry package `mcp.id/billing_transactions`, served on MCP mount `id.billing`. - name: credit_lots description: Registry package `mcp.id/credit_lots`, served on MCP mount `id.billing`. - name: credit_transactions description: >- Registry package `mcp.id/credit_transactions`, served on MCP mount `id.billing`. - name: gtm_connections description: >- Registry package `mcp.id/gtm_connections`, served on MCP mount `id.identity`. - name: notifications description: >- Registry package `mcp.id/notifications`, served on MCP mount `id.notifications`. - name: oauth_authorizations description: >- Registry package `mcp.id/oauth_authorizations`, served on MCP mount `id.access`. - name: oauth_clients description: Registry package `mcp.id/oauth_clients`, served on MCP mount `id.access`. - name: sessions description: Registry package `mcp.id/sessions`, served on MCP mount `id.identity`. - name: ssl_certificates description: >- Registry package `mcp.id/ssl_certificates`, served on MCP mount `id.partner`. - name: subscription_allocations description: >- Registry package `mcp.id/subscription_allocations`, served on MCP mount `id.partner`. - name: team_members description: Registry package `mcp.id/team_members`, served on MCP mount `id.identity`. - name: teams description: Registry package `mcp.id/teams`, served on MCP mount `id.identity`. - name: user_profiles description: >- Registry package `mcp.id/user_profiles`, served on MCP mount `id.identity`. - name: users description: Registry package `mcp.id/users`, served on MCP mount `id.identity`. - name: whitelabel_clients description: >- Registry package `mcp.id/whitelabel_clients`, served on MCP mount `id.partner`. - name: whitelabels description: Registry package `mcp.id/whitelabels`, served on MCP mount `id.partner`. - name: workspace_profiles description: >- Registry package `mcp.id/workspace_profiles`, served on MCP mount `id.identity`. paths: /api/api-keys: post: tags: - api_keys summary: Create API key description: >- Mint an API key and return the secret beside the item as the envelope's plaintext_token EXACTLY ONCE: hand it to the user at once, never log or echo it; if lost, rotate. permissions must sit inside the issuer's own grant (403 grant_exceeds_ceiling; * only from an unrestricted issuer). expires_at omitted = three years, null = perpetual. Natural key (team, name) among live keys (an expired or revoked key frees its name): a duplicate answers already_exists with the existing key and NO secret. Contract: - MCP tool `create_api_key`, registry package `mcp.id/api_keys`, mount `id.access`. - Operation `create`, response envelope `create`. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API. operationId: create_api_key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyRequest' responses: '200': description: '`create` success envelope.' content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: CreateApiKeyRequest: type: object description: Request body of `create_api_key`. properties: name: type: string minLength: 1 maxLength: 255 description: Human-readable key name; unique among the team's live keys. permissions: type: array items: type: string enum: - can_view_teams - can_manage_teams - can_view_team_members - can_manage_team_members - can_view_api_keys - can_manage_api_keys - can_view_oauth_clients - can_manage_oauth_clients - can_view_sessions - can_manage_sessions - can_view_account_shares - can_manage_account_shares - can_manage_account_transfers - can_view_billing - can_manage_billing - can_view_ssl_certificates - can_manage_ssl_certificates - can_view_notifications - can_manage_notifications - can_view_support_requests - can_manage_support_requests - can_view_linkedin_connections - can_act_linkedin_connections - can_view_linkedin_messages - can_act_linkedin_messages - can_act_linkedin_engagements - can_view_linkedin_searches - can_act_linkedin_searches - can_view_linkedin_enrichment - can_act_linkedin_enrichment - can_view_linkedin_accounts - can_update_linkedin_accounts - can_manage_linkedin_accounts - can_open_cloud_browser - can_change_proxy - can_edit_schedule - can_manage_smart_limits - can_manage_cloud_browser_external_links - can_share_vendor_profiles - can_act_linkedin_custom_requests - can_view_email_messages - can_act_email_messages - can_view_email_engagements - can_view_email_accounts - can_update_email_accounts - can_manage_email_accounts - can_view_email_suppressions - can_manage_email_suppressions - can_view_email_tracking_domains - can_manage_email_tracking_domains - can_view_email_sending_domains - can_manage_email_sending_domains - can_view_mass_actions - can_manage_mass_actions - can_view_webhooks - can_manage_webhooks - can_view_whitelabels - can_manage_whitelabels - can_view_integrations - can_manage_integrations - '*' description: >- A permission token of the gs catalog (can_view_teams, can_manage_webhooks, ...); * only from an unrestricted issuer. Playtables and inbox reads carry no tokens of their own yet. description: The explicit token list the key gets; inside the issuer's own grant. account_sids: type: array nullable: true items: type: string minLength: 18 maxLength: 18 pattern: ^ln_ac_ description: >- A LinkedIn account sid (ln_ac_...): one sender identity of the key's slice. minItems: 1 maxItems: 100 description: >- The sender identities the key may act on (ln_ac_...), inside the issuer's own slice; omitted or null = the issuer's whole slice. expires_at: type: string nullable: true description: ISO 8601 UTC; omit = now plus three years; null = perpetual. required: - name - permissions CreateApiKeyResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - create item: type: object properties: sid: type: string description: API key sid (id_ak_...). team_sid: type: string description: The workspace the key acts as (ts_tm_...). name: type: string description: Human-readable name, unique among the team's live keys. token_prefix: type: string description: The first characters of the token (gs_live_...), for display. token_last4: type: string description: The last four characters of the token, for display. permissions: type: array items: type: string description: 'What the key may do: the explicit token list.' account_sids: type: array nullable: true items: type: string description: >- The key's sender slice (ln_ac_...), clamped to its issuer's; null = every account of the issuer's own slice. status: type: string enum: - active - revoked - expired description: active = verifies; revoked | expired = refused. expires_at: type: string nullable: true description: >- ISO 8601 UTC; null = perpetual. Default at creation: three years. last_used_at: type: string nullable: true description: ISO 8601 UTC of the last verified call; null = never used. created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: 'Internal audit context: the cluster that served the write.' trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: 'The issuer: a person, or a parent key on delegation.' created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. deleted_at: type: string nullable: true description: ISO 8601 UTC; set with status revoked. required: - sid - team_sid - name - token_prefix - token_last4 - permissions - account_sids - status - expires_at - last_used_at - created_by - created_at - updated_at - deleted_at already_exists: type: boolean meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms plaintext_token: type: string description: >- The full secret, shown ONCE on a real mint; absent when already_exists is true. required: - success - operation - item - already_exists - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.