List Categories

GET https://{{axpAPIDomain}}/api/admin/match/v1/accounts/:accountId/categories?pageNumber=1&pageSize=10

Lists all the categories for an account in ascending name order.

Request Params

KeyDatatypeRequiredDescription
pageNumbernumberThe page number of the records to retrieve. Default value is 1.
pageSizenumberThe maximum number of results per page. Default value is 20, max value is 20.
namestringThe optional name of the category to query.

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":3},"categories":[{"categoryId":"4331fa35-9671-4ea0-94e0-517097a5a13a","name":"Language","attributes":[{"value":"French","name":"Language.French"},{"value":"German","name":"Language.German"}]},{"categoryId":"a730d229-c386-43df-9241-b5191af2725c","name":"Product","attributes":[{"value":"Landline","name":"Product.Landline"},{"value":"Mobile","name":"Product.Mobile"}]}],"links":{"next":"https://example.avayacloud.com/api/admin/match/api/admin/match/v1/accounts/{{accountId}}/categories?pageNumber=3\u0026pageSize=10","prev":"https://example.avayacloud.com/api/admin/match/api/admin/match/v1/accounts/{{accountId}}/categories?pageNumber=1\u0026pageSize=10"}}