# List the workspace's credit buckets

Needs workspace:billing:view.

`GET /api/v1/public/workspaces/workspaceId/credits/buckets`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs `workspace:billing:view`. Paginated, newest first, filterable by `status` and `source`.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

| Field    | Type   | Required | Constraints             | Description |
| -------- | ------ | -------- | ----------------------- | ----------- |
| `limit`  | number | No       | at least 1, at most 100 | -           |
| `page`   | number | No       | at least 1              | -           |
| `source` | string | No       | -                       | -           |
| `status` | string | No       | -                       | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/credits/buckets" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/credits/buckets',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/credits/buckets",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "docs": [
    {
      "_id": "000000000000000000000001",
      "activatedAt": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "creditAmount": 200,
      "creditPackage": {
        "_id": "000000000000000000000002",
        "creditAmount": 200,
        "name": "Credit 200",
        "slug": "credit-200-1767225600000"
      },
      "creditPackageVersion": "000000000000000000000002",
      "deleted": false,
      "expiresAt": "2026-01-01T00:00:00.000Z",
      "grantedBy": "000000000000000000000003",
      "id": "000000000000000000000001",
      "metadata": {},
      "orgId": "000000000000000000000004",
      "remaining": 40,
      "source": "admin_grant",
      "status": "active",
      "subjectId": "000000000000000000000005",
      "subjectType": "workspace",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "workspace": "000000000000000000000005"
    },
    {
      "_id": "000000000000000000000006",
      "activatedAt": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "creditAmount": 500,
      "creditPackage": {
        "_id": "000000000000000000000007",
        "creditAmount": 500,
        "name": "Credit 500",
        "slug": "credit-500-1767225600000"
      },
      "creditPackageVersion": "000000000000000000000007",
      "deleted": false,
      "grantedBy": "000000000000000000000003",
      "id": "000000000000000000000006",
      "metadata": {},
      "orgId": "000000000000000000000004",
      "remaining": 500,
      "source": "admin_grant",
      "status": "active",
      "subjectId": "000000000000000000000005",
      "subjectType": "workspace",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "workspace": "000000000000000000000005"
    }
  ],
  "hasNextPage": false,
  "hasPrevPage": false,
  "limit": 10,
  "nextPage": null,
  "page": 1,
  "pagingCounter": 1,
  "prevPage": null,
  "totalDocs": 2,
  "totalPages": 1
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.credits.buckets.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
