Skip to main content
GET
/
basic
/
check-key
/
{apiKey}
Check API Key
curl --request GET \
  --url https://api.series.hr/basic/check-key/{apiKey}
Verify an API key is valid and get its associated workspace information.

​
Request

curl https://api.series.hr/basic/check-key/YOUR_API_KEY

​
Parameters

  • apiKey (path, required): The API key to validate

​
Response (Valid Key)

​
200
{
  "success": true,
  "data": {
    "valid": true,
    "workspaceId": "a7d5339a-5531-4336-99c6-6f3249c9ac20",
    "workspaceName": "My Organization",
    "status": "active",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastUsed": "2024-01-05T11:30:00Z",
    "rateLimitRemaining": 8542,
    "rateLimitReset": "2024-01-05T13:00:00Z"
  }
}

​
Response (Invalid Key)

​
200
{
  "success": true,
  "data": {
    "valid": false,
    "status": "inactive",
    "message": "API key is inactive or invalid"
  }
}

Path Parameters

​
apiKey
string
required

Response

200

API key validation result