Authentication

Check API key access

Verify that your API key is valid and return the workspace and access attached to it.

get/health

Request

  • Base URL: https://contracko.com/api/v1
  • URL: https://contracko.com/api/v1/health
  • Auth: one of:
    • API key in header x-contracko-api-key
    • HTTP bearer

Response

API key verified.

status'ok' required

Health status for the authenticated API key

timestampstring date-time required

ISO-8601 timestamp generated by the API

keyIdstring required

Unique identifier for the API key

keyNamestring nullable

Label assigned to the API key

scopesstring[] required

Access granted to the API key

Changes

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