List groups

Returns the profile's product groups, one page at a time. A group is a category for filing products. It has no effect on prices or orders.

  • The list has no fixed order and can't be sorted. Sort on your side if order matters.
  • products_count is the number of products filed under the group. It's read-only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

Query Params
string

Search term. Matches part of the group name. Not case-sensitive. The description isn't searched.

string
enum

active or inactive. Not case-sensitive. An unrecognised value is ignored and the full list is returned.

Allowed:
integer
Defaults to 1

Page number, starting at 1. Pages hold 20 groups, and the page size can't be changed. A page past the last one returns 404. 0, a negative number or a non-number returns 500.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json