Skip to main content
GET
/
activity-credits
/
status
/
{workspaceId}
Get Credit Status
curl --request GET \
  --url https://api.series.hr/activity-credits/status/{workspaceId} \
  --header 'apikey: <api-key>'
Retrieve the current month’s activity credit usage status for a workspace.

​
Request

curl -X GET https://api.series.hr/activity-credits/status/workspace_12345 \
  -H "apikey: YOUR_API_KEY"

​
Parameters

​
workspaceId
string
required
The workspace ID

​
Response

​
200
{
  "success": true,
  "data": {
    "workspaceId": "workspace_12345",
    "month": "2024-01",
    "totalCredits": 10000,
    "usedCredits": 3500,
    "remainingCredits": 6500,
    "percentageUsed": 35
  }
}

Authorizations

​
apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Path Parameters

​
workspaceId
string
required

Response

200

Credit status