VTEX Prospects API
The Prospects API from VTEX — 4 operation(s) for prospects.
VTEX Prospects API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Prospects. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against a single base URL, https://{providerApiEndpoint}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
VTEX Prospects API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).
VtexIdclientAutCookie— [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Payment (22 properties), Prospect (11 properties), PaymentData (8 properties), ProspectMeta (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from VTEX 12
Other APIs VTEX publishes across the network.
This is an independent, third-party profile of VTEX Prospects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.