Table of Contents

What are Padoq categories?

Kate Santo Updated by Kate Santo

All padoqs (also known as groups) have categories assigned to them. Categories are a useful way to group padoqs together. Find out more about categories in this guide.

See for yourself

  • You can download the iOS or Android app on your phone to follow this journey along. And you can also log in or sign up to the web app here
  • You can also follow along by checking out the images or code snippets in this guide
  • And you will find the relevant endpoints linked and explained in this guide, but the full API is documented in Swagger UI

Categories

Categories are a property in the padoq structure. They group padoqs together and make it easier for users to find relevant content. The explore functionality uses categories heavily. Find out more about this below.

"categories": [
    "East side",
    "North east"
  ]

Categories are managed by the app's admin. They will have permission to create, update and delete categories via the createPadoqCategory, updatePadoqCategory and deletePadoqCategory endpoints.

Users with standard permissions can't create, update or delete categories.

Categories during padoq creation

When a user creates a padoq, the getPadoqCategories endpoint is called. It returns the categories in the app and their IDs.

{
  "categories": [
    {
      "name": "Property",
      "id": "2c2e08e3-59d7-4b8e-afa9-65458eca7fd3"
    },
    {
      "name": "Hospitality",
      "id": "2c2e08e3-59d7-4b8e-afa9-65458eca7fd3"
    },
    {
      "name": "Memberships",
      "id": "2c2e08e3-59d7-4b8e-afa9-65458eca7fd3"
    },
    {
      "name": "Retail",
      "id": "2c2e08e3-59d7-4b8e-afa9-65458eca7fd3"
    },
    {
      "name": "Workforce",
      "id": "2c2e08e3-59d7-4b8e-afa9-65458eca7fd3"
    }
  ]
}

In the web UI, these categories would display like this:

Once the user selects the relevant categories from those available and finishes the creation process, the padoq is created with one or more categories assigned to it.

Categories in Explore

When the user goes to Explore, the getPadoqs endpoint is called. This endpoint can take 4 parameters, and category is one of them.

When Explore is launched, the getPadoqCategories is called. It returns all categories available in the app, which are used to filter and organise results on this page. If the user taps on one of the categories presented, that category is passed to the getPadoqs endpoint via that category parameter. So the results returned in that case will be the padoqs that match that category.

How did we do?

Managing a padoq

Auto-enrolment

Contact