system-info

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

NameTypeDescription
statusSTRING REQUIRED“Success” string
user_idINTEGER REQUIREDUnique user identifier
emailSTRING
REQUIRED
Email of the user
project_idSTRINGUnique project identifier, ASCII string up to 36 characters long. Present only if the API key used for request is the project API key.
project_nameSTRINGProject name, unique for user account
»start_periodSTRING (UTC-DATE-TIME)
REQUIRED
Date and time of accounting period start in UTC in “YYYY-MM-DD hh:mm:ss” format
»end_periodSTRING (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"
}
NameTypeDescription
statusSTRING
REQUIRED
“Error” string
messageSTRING
REQUIRED
Human-readable error message in English
codeINTEGER
REQUIRED
API Error code