Fishbowl
Fishbowl Advanced REST API Documentation

Users

This is an object representing a Fishbowl user.

Related guide: Users

ENDPOINTS
GET /api/users
The user object
Attributes
  • id integer
    The user's unique identification number.
  • username string
    The username.
  • firstName string
    The first name of the user.
  • lastName string
    The last name of the user.
  • initials string
    The initials of the user's name.
  • active boolean
    The active status of the user.
  • customFields list
    A list of the custom fields associated with the user.
THE USER OBJECT
{
  "id": 1,
  "username": "admin",
  "firstName": "Administrator",
  "lastName": "Administrator",
  "initials": "ADM",
  "active": true
}
Search for users

Searches for users.

Parameters
  • pageNumber integer
    The current page of the results.
  • pageSize integer
    The number of returned results per page. (Default 100)
  • username string
    The username.
  • firstName string
    The first name of the user.
  • lastName string
    The last name of the user.
  • initials string
    The initials of the user's name.
  • active boolean
    The active status of the user.
Attributes
  • customFields list
    A list of the custom fields associated with the user.
GET /api/users 
curl --location \
--request GET '<YOUR SERVER>/api/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCount": 1,
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 1,
  "results": [
    {
      "id": 1,
      "username": "admin",
      "firstName": "Administrator",
      "lastName": "Administrator",
      "initials": "ADM",
      "active": true
    }
  ]
}