Skip to main content

Get Company API Key


Retrieve the API key for a specific company. Use this endpoint if you need to recover the company API key after creation.

Endpoint

PropertyValue
URLGET /white-label-partner/{companyId}/api-key
MethodGET
AuthR-Auth: <partner-jwt>

Example Request


curl --location '{{baseUrl}}/white-label-partner/{{companyId}}/api-key' \
--header 'R-Auth: {{partnerJwt}}'

Path parameters

ParameterTypeRequiredDescription
companyIdUUIDYesCompany UUID returned from Create company

Response

{
"companyId": "f5e6d7c8-1234-5678-9abc-def012345678",
"apiKey": "<company-apiKey>"
}

Response fields

FieldDescription
companyIdCompany UUID
apiKeyCompany-scoped API key used to obtain a company JWT through Authentication