Skip to main content
GET
List modules

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number

Required range: 1 <= x <= 10000
limit
integer
default:250

Number of modules to return per page

Required range: 1 <= x <= 250
sortBy
enum<string>
default:popular

Sort order for the module list

Available options:
popular,
usage-desc,
usage-asc,
recent,
name-asc,
name-desc,
rating
fields
enum<string>

Use preview to return the compact module payload used by catalog UIs

Available options:
preview

Search term matched against module name, type, description, and tags

Maximum string length: 120
searchType
string
default:All

Filter by module search type, or All for all types

Maximum string length: 80
Example:

"Pseudonym"

category
string
default:All

Filter by catalog category, or All for all categories

Maximum string length: 80
Example:

"Social Media"

When true, return only featured modules

Response

Module catalog page

aggregations
object
required

Module counts by category and search type, used to build filters.

Featured modules that match the current filters.

items
object[]
required

Modules on the requested page.

modules
object[]
required

Alias of items for clients that expect a module list property

pagination
object
required

Pagination details for items.

total
integer
required

Number of modules that match the filters, across all pages. Same value as pagination.total.

Required range: x >= 0