GET
/
external-api
/
v1
/
company
/
statistics
Get Company Statistics
curl --request GET \
  --url https://getbill.io/external-api/v1/company/statistics \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "message": "Success",
  "data": {
    "debts": {
      "total": 1247
    },
    "followups": {
      "total": 3421
    }
  }
}

ā€‹
Overview

This endpoint provides basic statistics about your debt collection activities, including total counts of debts and followups.

ā€‹
Authentication

Requires a valid OAuth 2.0 access token with the company:read scope.

ā€‹
Request

ā€‹
Authorization
string
required
Bearer token for authentication

ā€‹
Query Parameters

This endpoint does not accept any query parameters. Statistics are calculated for all time.

ā€‹
Example Request

curl -X GET "/external-api/v1/company/statistics" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

ā€‹
Response

ā€‹
error
boolean
Always false for successful requests
ā€‹
message
string
Success message
ā€‹
data
object
Statistics data

ā€‹
Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "debts": {
      "total": 1247
    },
    "followups": {
      "total": 3421
    }
  }
}