User information API

The endpoint returns information about a user account. It is helpful to check the account balance status and other data. The /user endpoint can be authenticated only with a secret. The token is not accepted.

User information request example

[GET]
https://v2.convertapi.com/user?Secret=your-api-secret

[response]
{    
    "Secret": "your-api-secret",
    "ApiKey": 834345618,
    "Active": true,
    "FullName": "Name Surname",
    "Email": "user@example.com",
    "ConversionsTotal": 5000,
    "ConversionsConsumed": 1642 
}

Usage statistics information request example

The endpoint that returns information about your usage statistics based on the date range. The data can be returned in either JSON or a comma-separated values (CSV) format depending on a Accept header value. Please set one of the following headers to your request:

- Accept: application/json
- Accept: text/csv

[GET]
https://v2.convertapi.com/user/statistic?secret=your-api-secret&startDate=2020-01-01&endDate=2020-02-01

Updated on: 22/02/2024