OpenFish Documentation

Appearance

Get users​

GET
/api/v1/users

Gets paginated users. When invoked by an admin, the full user object is returned, otherwise the public user only.

Parameters​

Query Parameters

limit

Number of results to return.

Typeinteger
offset

Number of results to skip.

Typeinteger

Responses​

OK
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"display_name": "Coral Fischer",
"email": "coral.fischer@example.com",
"id": 1234567890,
"role": "annotator"
}
],
"total": 1
}

Samples​

cURL
curl -X GET https://openfish.appspot.com/api/v1/users
JavaScript
fetch("https://openfish.appspot.com/api/v1/users")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("https://openfish.appspot.com/api/v1/users");
Python
import requests
response = requests.get("https://openfish.appspot.com/api/v1/users")
print(response.json())