v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-291317322.2 KB
Roles

Get list of roles

Returns a list of License Manager roles. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently the amount of pages for the whole list.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
License ManagerServices access controlGet paged roles

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/license-manager/site/pvt/roles/list/paged

Query parameters

numItemsinteger
Example:10

Number of items in the returned page.

pageNumberinteger
Example:1

Which page from the whole list will be returned.

sortstring
Example:id

Chooses the field that the list will be sorted by.

sortTypestring
Example:ASC

Defines the sorting order. ASC is used for ascendant order. DSC is used for descendant order.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Success