Get Company Profile
curl --request GET \
--url https://getbill.io/external-api/v1/company/profile \
--header 'Authorization: <authorization>'import requests
url = "https://getbill.io/external-api/v1/company/profile"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://getbill.io/external-api/v1/company/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getbill.io/external-api/v1/company/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://getbill.io/external-api/v1/company/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://getbill.io/external-api/v1/company/profile")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-api/v1/company/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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"
}
}
Company API
Get Company Profile
Retrieve the authenticated company’s profile information
GET
/
external-api
/
v1
/
company
/
profile
Get Company Profile
curl --request GET \
--url https://getbill.io/external-api/v1/company/profile \
--header 'Authorization: <authorization>'import requests
url = "https://getbill.io/external-api/v1/company/profile"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://getbill.io/external-api/v1/company/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getbill.io/external-api/v1/company/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://getbill.io/external-api/v1/company/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://getbill.io/external-api/v1/company/profile")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-api/v1/company/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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 thecompany:read scope.
Request
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"
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()
Response
boolean
Always
false for successful requestsstring
Success message
object
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 hourUsage Notes
- The company profile contains sensitive information and should be cached appropriately
- Use the Get Company Statistics endpoint for aggregate counts and metrics
Related Endpoints
- Get Company Statistics - Detailed analytics and metrics
- Get Company Credits - Credit balance and subscription info
- Get Company Users - List of company users