For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organisation

Get credit balances and dataset limits

get

Credits are consumable balances spent on enrichment. Limits are ceilings on dataset size, each reported with its current usage. A null value means no limit is set.

Authorizations
AuthorizationstringRequired

Your Goodfit API key, sent as the bare header value

Responses
200

Get credit balances and dataset limits

application/json
get/organisation/credits
GET /organisation/credits HTTP/1.1
Host: api.goodfit.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "credits": {
    "contact": 1,
    "phoneNumber": 1
  },
  "limits": {
    "companies": {
      "limit": 1,
      "usage": 1
    },
    "contacts": {
      "limit": 1,
      "usage": 1
    }
  }
}

Last updated