List Creditors

{
  "error": false,
  "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"
    },
    {
      "id": "xyz789ghi012",
      "name": "Services Plus SARL",
      "email": "contact@servicesplus.fr",
      "phone": "+33472987654",
      "address": "456 Avenue des Services",
      "city": "Lyon",
      "postalCode": "69001",
      "country": "France",
      "registrationNumber": "B987654321",
      "taxNumber": "FR98765432109",
      "contactPerson": "Marie Finance",
      "createdAt": "2024-01-10 09:15:00",
      "updatedAt": "2024-01-18 11:45:00"
    }
  ],
  "pagination": {
    "total": 128,
    "page": 1,
    "limit": 50,
    "pages": 3
  }
}

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

{
  "error": true,
  "message": "Required scope \"creditors:read\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Company not found or not authorized",
  "code": 404
}

Overview

This endpoint returns a paginated list of creditors belonging to the authenticated company. Creditors are entities (companies or organizations) that issue debts and have debtors owing them money.

Authentication

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

Example Request

curl -X GET "/external-api/v1/creditors?page=1&limit=50" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

const params = new URLSearchParams({
  page: '1',
  limit: '50'
});

const response = await fetch(`/external-api/v1/creditors?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const creditors = await response.json();

import requests

params = {
    'page': 1,
    'limit': 50
}

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.get(
    '/external-api/v1/creditors',
    headers=headers,
    params=params
)

creditors = response.json()

Example Response

{
  "error": false,
  "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"
    },
    {
      "id": "xyz789ghi012",
      "name": "Services Plus SARL",
      "email": "contact@servicesplus.fr",
      "phone": "+33472987654",
      "address": "456 Avenue des Services",
      "city": "Lyon",
      "postalCode": "69001",
      "country": "France",
      "registrationNumber": "B987654321",
      "taxNumber": "FR98765432109",
      "contactPerson": "Marie Finance",
      "createdAt": "2024-01-10 09:15:00",
      "updatedAt": "2024-01-18 11:45:00"
    }
  ],
  "pagination": {
    "total": 128,
    "page": 1,
    "limit": 50,
    "pages": 3
  }
}

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

{
  "error": true,
  "message": "Required scope \"creditors:read\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Company not found or not authorized",
  "code": 404
}

Rate Limiting

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

Get Single Creditor - Get detailed information about a specific creditor
Update Creditor - Update an existing creditor
List Debts by Creditor - Get all debts for a specific creditor

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Overview

Authentication

Example Request

Example Response

Rate Limiting

​Overview

​Authentication

​Example Request

​Example Response

​Rate Limiting

​Related Endpoints

Overview

Authentication

Example Request

Example Response

Rate Limiting

Related Endpoints