GET
/
external-api
/
v1
/
company
/
profile
Get Company Profile
curl --request GET \
  --url https://getbill.io/external-api/v1/company/profile \
  --header 'Authorization: <authorization>'
{
  "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.

​
Request

​
Authorization
string
required
Bearer token for authentication

​
Example Request

curl -X GET "/external-api/v1/company/profile" \
  -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
Company profile data

​
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
}

​
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