API documentation  GET /admin/users

Get user details.

GET https://demo.trafficmanager.com/api/v1/admin/users

Authentication:

The request must be authenticated with the following HTTP headers:

• x-api-key: Your API key, found on the Security page
• x-user-id: Your User ID, found on the Security page

GET Parameters:

• Optional:
• csv: if set, the response will be returned in CSV format instead of JSON
• ids: comma-separated list of user IDs, as integers. Any other value returns a 400 error
• role: role filter, as an integer. Only returns users with the given role. See role IDs in the returned values section below. Any other value returns a 400 error
• status: status filter, as an integer. See the list of status IDs below. Any other value returns a 400 error
• limit: maximum number of results, as a positive integer. If not set, all the matching users are returned. Any other value returns a 400 error
• offset: first row of the dataset to return, as an integer. Useful to retrieve the results in smaller pages. Any other value returns a 400 error. Default: 0.

Results are read in batches, ordered by user ID. Users created while the response is being sent may appear in later batches, so paged results are not a point-in-time snapshot.

Returned values:

• id: user ID
• uuid: user UUID
• username: username of the user
• email: user's email address
• role: user's role:
  • 0: User
  • 1: Admin
  • 2: Advertiser
  • 3: Affiliate manager
  • 4: Manager
  • 5: Finance department
  • 6: Operator
  • 7: Supplier
• status: user's status:
  • -3: Inactive and banned
  • -2: Unapproved
  • -1: Pending approval
  • 0: Banned
  • 1: Active
  • 3: Inactive
• is_email_verified: whether the email was verified or not
• lang: user's language
• registration_date: user's registration date
• last_login: user's last login date
• pending: user's pending credit, in EUR
• credit: user's credit, in EUR
• referer_id: user's referrer ID
• affiliate_manager_id: user's affiliate manager ID
• affiliateManagers: list of all affiliate manager IDs assigned to the user
• last_login_ip: user's last login IP
• country: user's country
• first_name: user's first name
• last_name: user's last name
• company_name: user's company name
• tax_number: user's tax number
• is_vat_valid: whether the European VAT Number is valid or not
• city: user's city
• address: user's address
• phone: user's phone
• zip: user's zip code
• skype: user's Skype username
• telegram: user's Telegram username
• regno: company registration number
• account_type: user's account type:
  • 1: Company
  • 2: Individual
• additionalFields: the custom profile fields of the user, as a JSON object

Request example

GET https://demo.trafficmanager.com/api/v1/admin/users

Response example

{
  users: [
    {
      "id":1,
      "uuid":"6673616e-6365-7363-6f2d-6c6f7b6b6100",
      "username":"John",
      "email":"john@yahoo.com",
      "role":1,
      "status":1,
      "is_email_verified":true,
      "lang":"en",
      "registration_date":"2016-07-08 23:23:46",
      "last_login":"2021-09-20 11:13:10",
      "pending":"0.000015",
      "credit":"75703.410780",
      "referer_id":null,
      "affiliate_manager_id":null,
      "affiliateManagers":[],
      "last_login_ip":"10.0.2.2",
      "country":"RO",
      "first_name":"John",
      "last_name":"Doe",
      "company_name":"Company",
      "tax_number":"12345",
      "is_vat_valid":0,
      "city":"Brașov",
      "address":"Strada X",
      "phone":"+407434352",
      "zip":"500123",
      "skype":"john_doe",
      "telegram":"",
      "regno":"12312",
      "account_type":1,
      "additionalFields":null
    },
    {
      "id":2,
      "uuid":"6075c39f-7e44-3a47-45c2-a1c392c2a662",
      "username":"admin",
      "email":"info@tubeadvertising.eu",
      "role":1,
      "status":3,
      "is_email_verified":true,
      "lang":"en",
      "registration_date":"2016-07-12 08:06:24",
      "last_login":"2019-07-18 12:17:00",
      "pending":"-942.548833",
      "credit":"0",
      "referer_id":null,
      "affiliate_manager_id":null,
      "affiliateManagers":[3,17],
      "last_login_ip":null,
      "country":"RO",
      "first_name":"",
      "last_name":"",
      "company_name":"",
      "tax_number":null,
      "is_vat_valid":0,
      "city":"",
      "address":"",
      "phone":"",
      "zip":"",
      "skype":"",
      "telegram":null,
      "regno":null,
      "account_type":2,
      "additionalFields":{"vertical":"casino"}
    },
  ],
  status: 200
}
    

---

CSV

You can also get the response in CSV instead of JSON. Simply add csv=1 as a GET parameter.

Request example:

GET https://demo.trafficmanager.com/api/v1/admin/users/?csv=1

Response example:

id,uuid,username,email,role,status,is_email_verified,lang,registration_date,last_login,pending,credit,referer_id,affiliate_manager_id,affiliateManagers,last_login_ip,country,first_name,last_name,company_name,tax_number,is_vat_valid,city,address,phone,zip,skype,telegram,regno,account_type,additionalFields
1,6673616e-6365-7363-6f2d-6c6f7b6b6100,John,john@yahoo.com,1,1,1,en,"2016-07-08 23:23:46","2021-09-27 12:39:18",0.000015,75703.410780,,,,10.0.2.2,RO,John,Doe,Company,12345,0,Brașov,"Strada X",+407434352,500123,john_doe,,12312,1,
2,6075c39f-7e44-3a47-45c2-a1c392c2a662,admin,info@tubeadvertising.eu,1,3,1,en,"2016-07-12 08:06:24","2019-07-18 12:17:00",-942.548833,0,,,"3,17",,RO,,,,,0,,,,,,,,2,"{""vertical"":""casino""}"