Gets user info by API key.
https://dns-name/system/info
Request Body
POST https://dns-name/system/info
Content-Type: application/json
X-API-KEY: Value
{}
Response Body
{
"status": "string",
"email": "string",
"user_id": 0,
"project_id": "string",
"project_name": "string",
"account_details": {
"start_period": "string",
"end_period": "string",
"emails_by_period": 0,
"emails_sent": 0
}
}
HTTP Code 200:
User info successfully returned |
Response Parameters
Name | Type | Description |
---|---|---|
status | STRING REQUIRED | “Success” string |
user_id | INTEGER REQUIRED | Unique user identifier |
STRING REQUIRED | Email of the user | |
project_id | STRING | Unique project identifier, ASCII string up to 36 characters long. Present only if the API key used for request is the project API key. |
project_name | STRING | Project name, unique for user account |
»start_period | STRING (UTC-DATE-TIME) REQUIRED | Date and time of accounting period start in UTC in “YYYY-MM-DD hh:mm:ss” format |
»end_period | STRING (UTC-DATE-TIME) REQUIRED | Date and time of accounting period end in UTC in “YYYY-MM-DD hh:mm:ss” format |
HTTP Code default:
Error occurred |
{
"status": "string",
"code": 0,
"message": "string"
}
Name | Type | Description |
---|---|---|
status | STRING REQUIRED | “Error” string |
message | STRING REQUIRED | Human-readable error message in English |
code | INTEGER REQUIRED | API Error code |