VTEX · Example Payload

Vtex Getlistroles Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getlistroles Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "GetListRoles",
  "method": "GET",
  "path": "/api/license-manager/site/pvt/roles/list/paged",
  "summary": "VTex Get list of roles",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "items": [
          {
            "id": 957,
            "isAdmin": false,
            "roleType": 0,
            "products": [
              {
                "id": null,
                "categoryId": null,
                "categoryName": null,
                "description": null,
                "consoleUrlMask": null,
                "urlConfiguration": null,
                "webApiUrlMask": null,
                "url": null,
                "productResources": null,
                "name": "Catalog"
              },
              {
                "id": null,
                "categoryId": null,
                "categoryName": null,
                "description": null,
                "consoleUrlMask": null,
                "urlConfiguration": null,
                "webApiUrlMask": null,
                "url": null,
                "productResources": null,
                "name": "OMS"
              }
            ],
            "resources": null,
            "logins": null,
            "name": "Call center operator"
          }
        ],
        "paging": {
          "page": 1,
          "perPage": 1,
          "total": 1,
          "pages": 1
        }
      }
    }
  ]
}