---
title: "Get credits"
method: GET
path: "/v1/credits"
tags: ["Credits"]
---

# Get credits

`GET /v1/credits`

## Request

- Base URL: `https://api.folk.app`
- URL: `https://api.folk.app/v1/credits`
- Auth: HTTP bearer

Retrieve the credits used and available for each metered feature of the workspace in the current period. Credits reset at the end of the period. Needs the contributor role or above in the workspace.

## Response `200`

The credits of the workspace.

- object
  - `data` object, required: The credits of the workspace for each metered feature, in the current period.
    - `items` object[], required: The credits of each metered feature, not paginated.
      - `feature` 'person_enrichment' | 'company_research' | 'ai_fields' | 'workflow_executions' | 'messages', required: The metered feature. `person_enrichment`: enrichment of people's emails and phones (`POST /v1/person-enrichments`), charged per person and field found. `company_research`: research on companies. `ai_fields`: values generated by AI in fields. `workflow_executions`: workflow executions. `messages`: messages sent in campaigns. New values may be added in the future: handle unknown values gracefully.
      - `scope` 'workspace' | 'user', required: Who shares the credits. `workspace`: one pool shared by the whole workspace. `user`: each member has their own pool; the values are those of the user of the API key. New values may be added in the future: handle unknown values gracefully.
      - `used` integer, required: The credits consumed in the current period. Can exceed `limit` if the limit was lowered during the period.
      - `limit` integer, nullable, required: The credits available per period, or null if unlimited. 0 means the feature is not available.
      - `periodStart` string, date-time, required: The start of the current period.
      - `periodEnd` string, date-time, required: The end of the current period, when `used` resets to 0.
  - `deprecations` string[]

## Other responses

- `400`: The request was unacceptable, often due to missing an invalid parameter.
- `401`: No valid API key provided.
- `403`: The API key doesn’t have permissions to perform the request.
- `404`: The requested resource doesn’t exist.
- `422`: The request was unacceptable, often due to missing or invalid parameters.
- `429`: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500`: Something went wrong on our end.
- `503`: The server is overloaded or down for maintenance.

## Changes

- **2026-11-03** `c6818f3ba60d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/folk/apis/folk-external-api/changes/v1/credits/get.md)

---

[API](https://skmtc.dev/folk/apis/folk-external-api.md) - [All operations](https://skmtc.dev/folk/apis/folk-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/folk/apis/folk-external-api/revisions/c6818f3ba60d?raw)