Profile System

vtex · Company

Company No Auth Free & Open API

Create shopper profiles and manage their information.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get profile

Retrieves the information of a specific client, by its `profileId`. > Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. > For security and privacy reasons, this request returns masked

https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}?alternativeKey=email

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}?alternativeKey=email" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "alternativeKey": "email"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}');
url.searchParams.set('alternativeKey', 'email');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}")
	q := baseURL.Query()
	q.Set("alternativeKey", "email")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}")
uri.query = URI.encode_www_form({
  "alternativeKey" => "email"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}?" . http_build_query([
    "alternativeKey" => "email"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get prospect

Retrieves the information of a specific prospect, by its `prospectId`. > For security and privacy reasons, this request returns masked prospect data. For unmasked information, see Get unmasked prospect. > Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/prof

https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/prospects/{prospectId}";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get client addresses

Retrieves information of all addresses of a given client, by its `profileId`. > For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked client addresses. > Learn more about the [Profile System](https://developers.vtex.com/vtex-rest

https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses?alternativeKey=email

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses?alternativeKey=email" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "alternativeKey": "email"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses');
url.searchParams.set('alternativeKey', 'email');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses")
	q := baseURL.Query()
	q.Set("alternativeKey", "email")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses")
uri.query = URI.encode_www_form({
  "alternativeKey" => "email"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/api/storage/profile-system/profiles/{profileId}/addresses?" . http_build_query([
    "alternativeKey" => "email"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Profile System?

Profile System is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Profile System is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗