Verify an API project key
GET https://localise.biz/api/auth/verify
Loco API keys authenticate your user account for accessing a specific project.
This endpoint verifies an API key and returns the authenticated user, account and project.
If you want to verify whether the key has write access, just send this endpoint a POST request instead. A read-only key will give 403 for any POST request.
URI parameters
key
|
API key - required if not sent in Authorization header |
string | optional |
Request headers
Authorization
|
API key sent as |
string | required if not in query |
Response
A single JSON-encoded Credentials object, which takes the following form:
{
"user": {
"id": 0, // User id
"name": "", // Full user name
"email": "", // Contact email address if you have permission to see it
},
"group": {
"id": 0, // Loco account id
"name": "", // Loco account name
"url": "", // Dashboard URL
},
"project": {
"id": 0, // Project id
"name": "", // Project name
"url": "", // Project dashboard URL
}
}