VTEX · Example Payload

Vtex Getprofile Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getprofile 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": "GetProfile",
  "method": "GET",
  "path": "/api/storage/profile-system/profiles/{profileId}",
  "summary": "VTex Get profile",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "70caf394-8534-447e-a0ca-1803c669c771",
          "meta": {
            "version": "abc",
            "author": "e40e0b6d-0605-4fa6-8176-1d69fbaf0818",
            "creationDate": "13/12/2021T00:00:00Z",
            "lastUpdate": "13/12/2021T00:00:00Z"
          },
          "document": {
            "firstName": "J***",
            "lastName": "D**",
            "email": "j***.d**@e******.c**",
            "birthDate": "1925-11-17",
            "document": "1**********",
            "documentType": "CPF",
            "{customField}": "{value}"
          }
        }
      ]
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-getprofile-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.