FOfolk
Credits

Get credits

Changed on

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.

get/v1/credits

Request

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

Response

The credits of the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "feature": "person_enrichment",
        "scope": "workspace",
        "used": 120,
        "limit": 500,
        "periodStart": "2026-09-01T00:00:00.000Z",
        "periodEnd": "2026-10-01T00:00:00.000Z"
      },
      {
        "feature": "company_research",
        "scope": "workspace",
        "used": 12,
        "limit": 200,
        "periodStart": "2026-09-01T00:00:00.000Z",
        "periodEnd": "2026-10-01T00:00:00.000Z"
      },
      {
        "feature": "ai_fields",
        "scope": "workspace",
        "used": 800,
        "limit": 2000,
        "periodStart": "2026-09-01T00:00:00.000Z",
        "periodEnd": "2026-10-01T00:00:00.000Z"
      },
      {
        "feature": "workflow_executions",
        "scope": "workspace",
        "used": 3400,
        "limit": null,
        "periodStart": "2026-09-01T00:00:00.000Z",
        "periodEnd": "2026-10-01T00:00:00.000Z"
      },
      {
        "feature": "messages",
        "scope": "user",
        "used": 40,
        "limit": 2000,
        "periodStart": "2026-09-01T00:00:00.000Z",
        "periodEnd": "2026-10-01T00:00:00.000Z"
      }
    ]
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes