Sign up
Documentation menu

User Info Endpoint

The /user endpoint returns information about a user account. It is helpful for checking the account balance status and other data. These administrative endpoints require the Master Token (see Authentication); regular API Tokens are not accepted.

User information

[GET]
https://v2.convertapi.com/user
Authorization: Bearer YOUR_MASTER_TOKEN
[response]
{    
    "Active": true,
    "FullName": "Name Surname",
    "Email": "user@example.com",
    "ConversionsTotal": 5000,
    "ConversionsConsumed": 1642 
}

Response fields

Field Meaning
Active Whether the account is active and can convert files.
FullName Account holder name.
Email Account email address.
ConversionsTotal Conversions included in the current plan period.
ConversionsConsumed Conversions used in the current plan period.

The response may include additional legacy fields kept for backward compatibility.

Usage statistics

The /user/statistic endpoint returns usage statistics for a date range. The data is returned in either JSON or comma-separated values (CSV) format, depending on the Accept header value. Set one of the following headers on your request:

  • Accept: application/json
  • Accept: text/csv
[GET]
https://v2.convertapi.com/user/statistic?startDate=2020-01-01&endDate=2020-02-01
Authorization: Bearer YOUR_MASTER_TOKEN