Inventory

Get user inventories

get/inventories/list

Request

Query parameters

offsetinteger

The number of inventories to skip

limitinteger

The number of inventories return

searchstring

Searching within search keywords

sortbystring

Sort by column name

sortorderboolean

Sort order, ASC if true, DESC if false

include_suggestion_countboolean

Whether to include the number of suggestions.

Response

OK

totalinteger required

Count of user inventories

unseen_suggestionsinteger

Number of unseen suggestions

default_inventory_idinteger

ID of the user's default inventory

Example response

{
  "list": [
    {
      "source_suggestions": 1,
      "business_id": 1,
      "enumeration_wordlist": "custom",
      "has_custom_wordlist": true,
      "users_total": 1,
      "app_refresh_rate_days": 1
    }
  ],
  "actualInventory": {
    "source_suggestions": 1,
    "business_id": 1,
    "is_default": true
  },
  "default_inventory_id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.