> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Creates an organization-owned API key. > The one-time API token and safe key detail row. ## OpenAPI ````yaml /openapi.json post /organizations/api-keys/{id} openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /organizations/api-keys/{id}: post: tags: - Organizations summary: Creates an organization-owned API key. description: The one-time API token and safe key detail row. operationId: Organizations_IssueApiKey parameters: - name: id in: path required: true schema: type: string requestBody: description: The key expiration selection. Null expiration means no limit. content: application/json: schema: allOf: - $ref: '#/components/schemas/OrganizationApiKeyRequest' description: >- Defines the display name and access configuration for a new Leadping organization API key. application/*+json: schema: allOf: - $ref: '#/components/schemas/OrganizationApiKeyRequest' description: >- Defines the display name and access configuration for a new Leadping organization API key. required: true responses: '200': description: The API key was created successfully. content: application/json: schema: allOf: - $ref: '#/components/schemas/OrganizationApiKeyIssueResponse' description: >- Returns a newly issued organization API key and its identifying metadata; the secret credential is shown only in this response. '400': description: The request was invalid. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. '401': description: Authentication credentials are missing or invalid. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. '403': description: The caller cannot manage this organization API key. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. '429': description: The API rate limit for this account or client has been exceeded. headers: Retry-After: description: Number of seconds to wait before retrying the request. schema: minimum: 0 type: integer format: int32 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. security: - Bearer: [] components: schemas: OrganizationApiKeyRequest: type: object properties: name: type: - 'null' - string description: Human-readable name used to identify the key. expiresInDays: type: - 'null' - integer description: Number of days before the key expires. Null means no expiration. format: int32 permissions: type: - 'null' - array items: type: string description: WorkOS permission slugs granted to the API key. description: >- Defines the display name and access configuration for a new Leadping organization API key. OrganizationApiKeyIssueResponse: type: object properties: secret: type: string description: Secret token returned once when the Leadping API key is issued. expiresAt: type: - 'null' - string description: Date and time when the organization API key issue expires. format: date-time apiKey: allOf: - $ref: '#/components/schemas/OrganizationApiKeyPreviewResponse' description: API key associated with this Leadping organization API key issue. description: >- Returns a newly issued organization API key and its identifying metadata; the secret credential is shown only in this response. ProblemDetails: type: object properties: type: type: - 'null' - string description: URI reference that identifies the problem type. title: type: - 'null' - string description: Short, human-readable summary of the problem. status: type: - 'null' - integer description: HTTP status code returned for the problem. format: int32 detail: type: - 'null' - string description: >- Human-readable explanation specific to this occurrence of the problem. instance: type: - 'null' - string description: >- URI reference that identifies this specific occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: >- Validation errors keyed by the JSON request field name. Present for request validation failures. traceId: type: string description: >- Request trace identifier used to correlate this problem with Leadping diagnostics. description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: https://leadping.ai/docs/errors/validation title: Request validation failed status: 400 detail: One or more request fields are invalid. instance: /leads/intake errors: email: - The email field is required. traceId: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 OrganizationApiKeyPreviewResponse: type: object properties: id: type: string description: Unique identifier of the API key. name: type: string description: Human-readable name of the API key. organization: allOf: - $ref: '#/components/schemas/IdNamePair' description: Organization that owns the API key. enabled: type: boolean description: Whether the API key can currently authenticate requests. preview: type: - 'null' - string description: >- Masked value that can be used to identify the key without revealing its secret. permissions: type: - 'null' - array items: type: string description: Permission slugs granted to the API key. issuedAt: type: - 'null' - string description: Date and time when the API key was issued. format: date-time firstUsedAt: type: - 'null' - string description: Date and time when the API key was first used. format: date-time lastUsedAt: type: - 'null' - string description: Date and time when the API key was last used. format: date-time expiresAt: type: - 'null' - string description: >- Date and time when the API key expires, or null when it does not expire. format: date-time totalUses: type: integer description: Total number of tracked uses. format: int64 createdAt: type: string description: Date and time when Leadping began tracking the API key. format: date-time modifiedAt: type: string description: Date and time when the tracked API-key metadata was last modified. format: date-time description: >- Safe identifying and usage metadata for an organization API key. This model never contains the secret credential. IdNamePair: required: - id - name type: object properties: id: type: string description: Stable unique identifier of the referenced resource. name: type: string description: Human-readable display name of the referenced resource. description: >- Provides a compact API reference to another resource using its stable identifier and human-readable display name. securitySchemes: Bearer: type: http description: >- Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_. scheme: bearer bearerFormat: JWT or organization API key ````