Skip to content

User Information APIs

Retrieve user information for public accounts. Any user can set their account to be public visible or hidden from public APIs. Private accounts will not show up in user lists or specific user searches.

Base URL: https://api.teamtbm.org

List all users

/v1/users GET

Example Requests

curl -X GET "https://api.teamtbm.org/v1/users"

<?php
$ch = curl_init("https://api.teamtbm.org/v1/users");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, false);
$response = curl_exec($ch);
$data = json_decode($response);

var_dump($data->users);
?>

const resp = await fetch('https://api.teamtbm.org/v1/users');
const data = await resp.json();

console.log(data.users);

Responses

{
  "success": true,
  "code": 200,
  "users": [
    {
      "username": "teamtbm",
      "display_name": "TeamTBM Official",
      "account_type": "business",
      "role": "Chief Executive Director",
      "premium": 2,
      "avatar": "https://gravatar.com/avatar/a9230da8a5fcf6c8e4cea8c4ab4fdbd9?s=500&d=https%3A%2F%2Fcdn2.teamtbm.org%2Favatars%2Fdefault.webp"
    },
  ]
}

A request method other than HTTP GET was used.

{
  "success": false,
  "code": 405,
  "message": "Method Not Allowed"
}

The client exceeded the maximum number of attempts within the given time period.

{
  "success": false,
  "code": 429,
  "message": "Too Many Requests"
}

An internal error has occurred preventing a successful request. See message field for more information.

{
  "success": false,
  "code": 500,
  "message": "Internal Server Error: <Error Description>"
}