Fishbowl
Fishbowl Advanced REST API Documentation

Location Groups

This is an object representing a Fishbowl location group.

Related guide: Location Groups

ENDPOINTS
GET /api/location-groups
The location group object
Attributes
  • id integer
    The location group's unique identification number.
  • name string
    The location group's name.
  • class reference object
    The class category.
  • active boolean
    The location group's active status.
THE LOCATION GROUP OBJECT
{
  "id": 1,
  "name": "Main",
  "class": {
    "id": 0,
    "name": ""
  },
  "active": true
}
Search for location groups

Searches for location groups.

Parameters
  • pageNumber integer
    The current page of the results.
  • pageSize integer
    The number of returned results per page. (Default 100)
  • name string
    The location group name.
  • active boolean
    The active status of the location groups.
Attributes

    No attributes.

GET /api/location-groups 
curl --location \
--request GET '<YOUR SERVER>/api/location-groups' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCount": 1,
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 100,
  "results": [
    {
      "id": 1,
      "name": "Each",
      "abbreviation": "ea",
      "description": "A single item.",
      "type": "Count",
      "active": true
    }
  ]
}