Get Company Profile

{
  "error": false,
  "message": "Success",
  "data": {
    "id": "hTBN7n6lkmkhMb6LYqEBZw",
    "name": "Example Collections LLC",
    "email": "contact@example-collections.com",
    "phone": "+33123456789",
    "created_at": "2023-01-15T10:30:00+00:00"
  }
}

Overview

This endpoint returns detailed information about the authenticated company, including contact details, configuration, and basic statistics.

Authentication

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

Example Request

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

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

const profile = await response.json();

import requests

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

response = requests.get(
    '/external-api/v1/company/profile',
    headers=headers
)

profile = response.json()

Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "id": "hTBN7n6lkmkhMb6LYqEBZw",
    "name": "Example Collections LLC",
    "email": "contact@example-collections.com",
    "phone": "+33123456789",
    "created_at": "2023-01-15T10:30:00+00:00"
  }
}

Error Responses

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

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

{
  "error": true,
  "message": "Company not found",
  "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

Usage Notes

The company profile contains sensitive information and should be cached appropriately
Use the Get Company Statistics endpoint for aggregate counts and metrics

Get Company Statistics - Detailed analytics and metrics
Get Company Credits - Credit balance and subscription info
Get Company Users - List of company users

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

Success Response

Error Responses

Rate Limiting

Usage Notes

​Overview

​Authentication

​Example Request

​Success Response

​Error Responses

​Rate Limiting

​Usage Notes

​Related Endpoints

Overview

Authentication

Example Request

Success Response

Error Responses

Rate Limiting

Usage Notes

Related Endpoints