Get the token's user
Answers the person the access token belongs to, with their company, their roles and each role's permissions. Use it to check that a token works and whose it is.
GET/ api/ user
Returns
200 The token's user.
Fields of the 200 answer
userobjectRequired
A person with a Control Panel account. Ids are sent as strings.
Fields
companyobject or any or null
The user's company, as GET /companies answers it. Null when the account belongs to no company.
company_idstringRequired
The id of the user's company, as a string of digits. An empty string when the account belongs to no company.
emailstringRequired
The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.
idstringRequired
The user's id, as a string of digits.
mobilestring or nullRequired
namestringRequired
rolearray of objectsRequired
The person's roles.
Fields of each item
namestringRequired
permissionsarray of stringsRequired
The keys of the permissions the role grants, such as viewWebsites.
slugstringRequired
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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/user \
-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/user');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/user', {
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/user",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"user": {
"company": {
"address": "14 Quay Street, Anytown, AB1 2CD",
"country": "GB",
"id": "1204",
"name": "Harbour & Finch",
"phone": "+44 20 7946 0142"
},
"company_id": "1204",
"email": "[email protected]",
"id": "2041",
"mobile": null,
"name": "Eleanor Finch",
"role": [
{
"name": "Owner",
"permissions": [
"viewWebsites",
"viewEnvironments",
"viewUsers",
"inviteUsers",
"viewInvoices"
],
"slug": "client-owner"
}
]
}
}{
"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
}Try it
Was this helpful?