Keys
Read who a key or an app's token acts as
The account id and name, and the organisation the key or the grant is for.
GET
/v1/meTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read who a key or an app's token acts as. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type Me. |
| What can go wrong? | 401 no key, or the key or token is not valid (oauth.invalid_token for a token); 403 the token's grant does not hold profile (oauth.insufficient_scope); 429 too many requests, or the daily limit is used up. Every failure uses the one error envelope. |
What it does
The account id and name, and the organisation the key or the grant is for. An app's token needs profile, and gets the address only with email. Open to every plan.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Who the call acts as. | Me |
| 401 | No key, or the key or token is not valid (oauth.invalid_token for a token). | ErrorResponse |
| 403 | The token's grant does not hold profile (oauth.insufficient_scope). | ErrorResponse |
| 429 | Too many requests, or the daily limit is used up. | ErrorResponse |
Response body
A 200 answer has the type Me.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | null | yes | |
email | string | no | The account's address: for a key always, for an app only with the email scope. |
organisation | object | null | yes | The organisation the key or the grant is for, or null. |
organisation.id | string | yes | |
organisation.slug | string | yes | |
organisation.name | string | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |