> ## Documentation Index
> Fetch the complete documentation index at: https://docs.series.hr/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Credit Status

> Get current month credit status for a workspace

Retrieve the current month's activity credit usage status for a workspace.

## Request

```bash theme={null}
curl -X GET https://api.series.hr/activity-credits/status/workspace_12345 \
  -H "apikey: YOUR_API_KEY"
```

## Parameters

<ParamField path="workspaceId" type="string" required>
  The workspace ID
</ParamField>

## Response

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "workspaceId": "workspace_12345",
      "month": "2024-01",
      "totalCredits": 10000,
      "usedCredits": 3500,
      "remainingCredits": 6500,
      "percentageUsed": 35
    }
  }
  ```
</ResponseField>


## OpenAPI

````yaml GET /activity-credits/status/{workspaceId}
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /activity-credits/status/{workspaceId}:
    get:
      tags:
        - Activity Credits
      summary: Get Credit Status
      description: Get current month credit status for a workspace
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Credit status
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````