List your agency's clients
The client companies linked beneath your own company, by name. A company that is not an agency has none.
GET/ api/ company/ clients
Returns
200 Your agency's clients.
Fields of the 200 answer
can_detachbooleanRequired
Whether you may detach a client. Owners only, and never in an archived company.
clientsarray of objectsRequired
By name. A client that has been deleted is named Removed company.
Fields of each item
idintegerRequired
At least 1.
namestringRequired
company_idintegerRequired
Your own company. At least 1.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/company/clients \
-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/clients');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/company/clients', {
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/clients",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"can_detach": true,
"clients": [
{
"id": 1204,
"name": "Harbour & Finch"
}
],
"company_id": 1180
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?