v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Coins

Get the coin credit balance for a company/member in a specific month.

Get the coin credit balance for a company/member in a specific month. Returns "monthly" and "once" balances of the coins. You must specify either "member id" or "company id" and "month" in the query of the request. If a member is part of a company, any coins that are assigned to the member will be transferred to the company. Always query for the "company id", if the member is part of a company.

Required scopes: flex.space.coins.read

get/api/v2/organizations/{orgSlug}/coins/stats

Path parameters

orgSlugstring required

organization slug

Query parameters

monthstring required

Example:2025-01

Filter by month in the format YYYY-MM.

companystring

Example:603dfbc260f4054084125d30

Filter by company id.

memberstring

Example:603dfbc260f4054084125d33

Filter by member id.

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "creditAccount": "603dfbc260f4054084125d30",
      "resourceRates": [
        "603dfbc260f4054084125d30",
        "603dfbc260f4054084125d31"
      ],
      "resourceTypes": [
        "603dfbc260f4054084125d30",
        "603dfbc260f4054084125d31"
      ],
      "oneOffPlans": [
        "603dfbc260f4054084125d30",
        "603dfbc260f4054084125d31"
      ],
      "member": "603dfbc260f4054084125d33",
      "company": "603dfbc260f4054084125d33",
      "monthly": {
        "total": 100,
        "used": 50,
        "remaining": 50
      },
      "once": {
        "total": 100,
        "used": 50,
        "remaining": 50
      }
    }
  ]
}