VEvetnio
data-export

Check the API key you are using

Returns the calling key's organization, scope, status, limits and request counts for today and the last 30 days. Use it as a first call to confirm a key works and to look up the organizationId for the other data-export paths. Only organization (sk_org_…) and workspace (sk_ws_…) keys are accepted: a personal API key or a browser session gets 400 BAD_REQUEST. The call itself counts toward the key's rate limits.

get/api-key

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/api-key
  • Auth
    HTTP bearer

Response

The API key used for this request.

namestring required

Label an organization admin gave the key when creating it under Organization → API. A rotated key keeps the name of the key it replaced.

organizationIdstring required

Identifier of the organization the key belongs to. Use it as {organizationId} in the /organizations/{organizationId}/… paths; any other organization ID returns 403.

status'active' | 'expiring' | 'expired' | 'revoked' required

Lifecycle state of the key:

  • active — valid and has no expiry date.
  • expiring — valid until expiresAt. A key replaced through rotation is expiring during its grace period.
  • expired — expiresAt has passed; the key no longer authenticates.
  • revoked — an admin revoked the key; it no longer authenticates. Because expired and revoked keys are rejected with 401 before this endpoint runs, a successful response is always active or expiring.
createdAtstring required

When the key was created, as an ISO-8601 UTC timestamp.

expiresAtstring nullable required

When the key stops working (ISO-8601 UTC), or null if it never expires. Rotating a key moves the old key's expiry to at most 24 hours after the rotation.

lastUsedAtstring nullable required

Approximate time of the key's most recent authenticated request (ISO-8601 UTC), or null if it has not been recorded yet. Refreshed at most once every 5 minutes, so it may lag and may not include the current request.

Example response

{
  "name": "Data warehouse sync",
  "organizationId": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e42",
  "scope": {
    "type": "organization",
    "id": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e42"
  },
  "status": "active",
  "createdAt": "2026-09-01T08:15:00.000Z",
  "lastUsedAt": "2026-09-28T06:00:12.000Z",
  "limits": {
    "requestsPerMinute": 60,
    "requestsPerDay": 10000
  },
  "usage": {
    "requestsToday": 42,
    "requestsLast30Days": 1250,
    "daily": [
      {
        "day": "2026-09-28",
        "requests": 37
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.