Skip to main content
POST
Creates an organization-owned API key.

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

id
string
required

The organization ID that will own the API key.

Body

The key expiration selection. Null expiration means no limit.

Defines the display name and access configuration for a new Leadping organization API key.

name
null | string

Human-readable name used to identify the key.

expiresInDays
null | integer<int32>

Number of days before the key expires. Null means no expiration.

permissions
null | string[]

WorkOS permission slugs granted to the API key.

Response

The API key was created successfully.

Returns a newly issued organization API key and its identifying metadata; the secret credential is shown only in this response.

secret
string

Secret token returned once when the Leadping API key is issued.

expiresAt
null | string<date-time>

Date and time when the organization API key issue expires.

apiKey
object

API key associated with this Leadping organization API key issue.