GET
/
external-api
/
v1
/
creditors
/
{id}
Get Creditor
curl --request GET \
  --url https://getbill.io/external-api/v1/creditors/{id} \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "abc123def456",
      "name": "Acme Corporation",
      "email": "billing@acmecorp.com",
      "phone": "+33142123456",
      "address": "123 Business Street",
      "city": "Paris",
      "postalCode": "75001",
      "country": "France",
      "registrationNumber": "B123456789",
      "taxNumber": "FR12345678901",
      "contactPerson": "John Billing",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-20 14:22:00",
      "totalDebts": 45,
      "totalAmount": 125750.00
    }
  }
}

​
Overview

This endpoint returns detailed information about a specific creditor identified by its encrypted ID.

​
Authentication

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

​
Request

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
id
string
required
The encrypted creditor ID

​
Example Request

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

​
Response

​
error
boolean
Always false for successful requests
​
data
object
The creditor object

​
Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "abc123def456",
      "name": "Acme Corporation",
      "email": "billing@acmecorp.com",
      "phone": "+33142123456",
      "address": "123 Business Street",
      "city": "Paris",
      "postalCode": "75001",
      "country": "France",
      "registrationNumber": "B123456789",
      "taxNumber": "FR12345678901",
      "contactPerson": "John Billing",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-20 14:22:00",
      "totalDebts": 45,
      "totalAmount": 125750.00
    }
  }
}

​
Error Responses

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}

​
Rate Limiting

This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hour