Get your company
Answers your own company's name, phone number, address and country. Its people are not part of the answer; for its notification settings use GET /company/details.
GET/ api/ company
Returns
200 Your company.
Fields of the 200 answer
companyobjectRequired
A company. Ids are sent as strings.
Fields
addressstring or nullRequired
countrystring or nullRequired
The company's country, as it is stored on the company.
idstringRequired
The company's id, as a string of digits.
namestringRequired
phonestring or nullRequired
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
429 | rate_limited | Wait for the seconds in Retry-After. |
500 | none | Read the message; it says what happened. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/company \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/company');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/company', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/company",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"company": {
"address": "14 Quay Street, Anytown, AB1 2CD",
"country": "GB",
"id": "1204",
"name": "Harbour & Finch",
"phone": "+44 20 7946 0142"
}
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"message": "Server Error"
}Try it
Was this helpful?