Skip to main content
GET
/
partner
/
organizations
/
by-external-id
/
{externalId}
Get a partner organization by external ID
curl --request GET \
  --url https://api.kelviq.com/api/v1/partner/organizations/by-external-id/{externalId}/ \
  --header 'X-Kelviq-Partner-Key: <api-key>'
{
  "userId": 4271,
  "organizationIdentifier": "8e1d7b1a-6c4d-4e3a-9b2d-3f6e4c2b1ad0",
  "organizationSlug": "acme-corp",
  "clientKey": "ck_live_a1b2c3d4e5f6",
  "serverKey": "sk_live_9z8y7x6w5v4u",
  "partnerExternalId": "acme-corp"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kelviq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Kelviq-Partner-Key
string
header
required

Partner integration secret issued by kelviq. Send the raw secret (prefixed kvqp_) in the X-Kelviq-Partner-Key header on every partner API request.

Path Parameters

​
externalId
string
required

Partner-side identifier supplied when the organization was provisioned.

Response

Organization details.

Organization owned by a partner. Returned by all partner organization endpoints.

​
userId
integer | null

Internal kelviq user ID of the organization owner.

Example:

4271

​
organizationIdentifier
string<uuid>

Stable UUID identifier for the organization.

Example:

"8e1d7b1a-6c4d-4e3a-9b2d-3f6e4c2b1ad0"

​
organizationSlug
string | null

URL-safe slug for the organization.

Example:

"acme-corp"

​
clientKey
string | null

Public client key for the organization's API integration.

Example:

"ck_live_a1b2c3d4e5f6"

​
serverKey
string | null

Private server key for the organization. Treat as a secret.

Example:

"sk_live_9z8y7x6w5v4u"

​
partnerExternalId
string | null

Partner-side identifier supplied at provisioning time.

Example:

"acme-corp"