API: Users

From Yombo
Jump to: navigation, search


Summary

Search for registered Yombo account users. You must have a valid account to complete a search. Due to the security nature of this, additional rate limit restrictions are in place.

GET - Find a user

Find a user by user_id or by email address. If searching by email, a complete email address must be supplied.

Request URLs

  • GET https://api.yombo.net/api/v1/user/{user_id / email address}

Parameters

None

Example

  <div id="curl<random_number></random_number>" class="tab-pane fade in active" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
curl \
-H "x-api-key: abc123xyz789" \
-H "authorization: Bearer Waro7g0Mwl4YBJ..." \
https://api.yombo.net/api/v1/command?_pagelimit=2
  <div id="python<random_number></random_number>" class="tab-pane fade" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
import requests

url = 'https://api.yombo.net/api/v1/command?_pagelimit=2'
headers = {
    'x-api-key': 'abc123xyz789',
    'authorization': 'Waro7g0Mwl4YBJ...',
    }
response = requests.get(url, headers=headers)
  <div id="output<random_number></random_number>" class="tab-pane fade" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
{
    "response": {
        "uri": "/api/v1/user/henry@example.com",
        "uri_description": "Find a single user based on ID or email.",
        "doc_uri": "https://yombo.net/API:Users",
        "user": {
            "id": "RgdrA8Rhl31qJ6yZ25",
            "name": "Henry",
            "email": "asdf2@schwenk.name"
        },
        "locator": "user",
        "locator_type": "integer"
    },
    "code": 200,
    "warnings": [],
    "message": "OK",
    "html_message": "OK"
}