Account Information

API Endpoint

This endpoint is used to retrieve your account’s detailed information, as well as information related to the API key pair you are using.

Request

• GET /account
• Request Headers:
  • X-API-Key: <API Key>

Response

Upon a successful call, this endpoint will return a JSON object containing your account details.

{
    "user": {
        "id": "user_id",
        "email": "your_email",
        "verified": true,
        "name": "name",
        "avatar": "",
        "created": "2024-05-10T10:00:00Z",
        "updated": "2024-05-10T10:00:00Z"
    },
    "api_key": {
        "id": "api_key_id",
        "name": "api_alias",
        "key":"api_key",
        "created": "2024-05-10T10:00:00Z",
        "last_used": "2024-05-10T10:00:00Z"
    }
}

Error Handling

If your request contains an invalid API key, the server will return a 401 Unauthorized error.

{
  "error": "Invalid API key"
}

Example

Below is an example of a curl call to this endpoint:

curl --request GET 
  --url https://api.spell.im/v1/account 
  --header 'X-API-Key: <Your API Key>'