Skip to main content
GET
/
partner
/
organizations
List partner organizations
curl --request GET \
  --url https://api.kelviq.com/api/v1/partner/organizations/ \
  --header 'X-Kelviq-Partner-Key: <api-key>'
{
  "results": [
    {
      "userId": 4271,
      "organizationIdentifier": "8e1d7b1a-6c4d-4e3a-9b2d-3f6e4c2b1ad0",
      "organizationSlug": "acme-corp",
      "clientKey": "ck_live_a1b2c3d4e5f6",
      "serverKey": "sk_live_9z8y7x6w5v4u",
      "partnerExternalId": "acme-corp"
    }
  ],
  "count": 1
}

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.

Query Parameters

​
external_id
string

If supplied, return only the organization with this partner-side identifier.

Response

List of organizations.

List response for partner organizations.

​
results
object[]
​
count
integer

Total number of organizations matching the query.

Example:

1