VTEX Do API

vtex · Company

Company No Auth Free & Open API

VTEX DO is a task management system for authorized users to process orders. It is possible to control notes, and create, update, list, and retrieve tasks.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get Notes by orderId

Retrieves notes related to a specific `orderId`.

https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes?page=3&reason=data-validation&perPage=20&target.id=1172452900788-01

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/VTEX-Do-API/1.0/notes?page=3&reason=data-validation&perPage=20&target.id=1172452900788-01" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "3",
    "reason": "data-validation",
    "perPage": "20",
    "target.id": "1172452900788-01"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes');
url.searchParams.set('page', '3');
url.searchParams.set('reason', 'data-validation');
url.searchParams.set('perPage', '20');
url.searchParams.set('target.id', '1172452900788-01');

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/VTEX-Do-API/1.0/notes")
	q := baseURL.Query()
	q.Set("page", "3")
	q.Set("reason", "data-validation")
	q.Set("perPage", "20")
	q.Set("target.id", "1172452900788-01")
	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/VTEX-Do-API/1.0/notes")
uri.query = URI.encode_www_form({
  "page" => "3",
  "reason" => "data-validation",
  "perPage" => "20",
  "target.id" => "1172452900788-01"
})

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/VTEX-Do-API/1.0/notes?" . http_build_query([
    "page" => "3",
    "reason" => "data-validation",
    "perPage" => "20",
    "target.id" => "1172452900788-01"
]);
$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 List tasks

This endpoint allows you to filter tasks. You can choose between the following filtering options: - **Assignees:** using `assignee.email` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{[email protected]}}&status={{open}}`. - **Targets:** u

https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/tasks?page={{page}}&status=open&context={{context}}&perPage={{desired number per page}}&target.id={{targetId}}&assignee.email={{assigneeEmail}}

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/VTEX-Do-API/1.0/tasks?page=%7B%7Bpage%7D%7D&status=open&context=%7B%7Bcontext%7D%7D&perPage=%7B%7Bdesired%20number%20per%20page%7D%7D&target.id=%7B%7BtargetId%7D%7D&assignee.email=%7B%7BassigneeEmail%7D%7D" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "{{page}}",
    "status": "open",
    "context": "{{context}}",
    "perPage": "{{desired number per page}}",
    "target.id": "{{targetId}}",
    "assignee.email": "{{assigneeEmail}}"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/tasks",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/tasks');
url.searchParams.set('page', '{{page}}');
url.searchParams.set('status', 'open');
url.searchParams.set('context', '{{context}}');
url.searchParams.set('perPage', '{{desired number per page}}');
url.searchParams.set('target.id', '{{targetId}}');
url.searchParams.set('assignee.email', '{{assigneeEmail}}');

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/VTEX-Do-API/1.0/tasks")
	q := baseURL.Query()
	q.Set("page", "{{page}}")
	q.Set("status", "open")
	q.Set("context", "{{context}}")
	q.Set("perPage", "{{desired number per page}}")
	q.Set("target.id", "{{targetId}}")
	q.Set("assignee.email", "{{assigneeEmail}}")
	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/VTEX-Do-API/1.0/tasks")
uri.query = URI.encode_www_form({
  "page" => "{{page}}",
  "status" => "open",
  "context" => "{{context}}",
  "perPage" => "{{desired number per page}}",
  "target.id" => "{{targetId}}",
  "assignee.email" => "{{assigneeEmail}}"
})

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/VTEX-Do-API/1.0/tasks?" . http_build_query([
    "page" => "{{page}}",
    "status" => "open",
    "context" => "{{context}}",
    "perPage" => "{{desired number per page}}",
    "target.id" => "{{targetId}}",
    "assignee.email" => "{{assigneeEmail}}"
]);
$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 Retrieve Note

Retrieves a given note in VTEX DO, filtering by `noteId`.

https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes/{noteId}?reason=data-validation

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/VTEX-Do-API/1.0/notes/{noteId}?reason=data-validation" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "reason": "data-validation"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes/{noteId}",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/VTEX-Do-API/1.0/notes/{noteId}');
url.searchParams.set('reason', 'data-validation');

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/VTEX-Do-API/1.0/notes/{noteId}")
	q := baseURL.Query()
	q.Set("reason", "data-validation")
	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/VTEX-Do-API/1.0/notes/{noteId}")
uri.query = URI.encode_www_form({
  "reason" => "data-validation"
})

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/VTEX-Do-API/1.0/notes/{noteId}?" . http_build_query([
    "reason" => "data-validation"
]);
$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 VTEX Do API?

VTEX Do API 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. VTEX Do API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗