--- title: "Get prospects" method: GET path: "/api/storage/profile-system/prospects" tags: ["Prospects"] --- # Get prospects `GET /api/storage/profile-system/prospects` Retrieves information of all prospects. > For security and privacy reasons, this request returns masked prospect data. For unmasked information, see [Get unmasked prospects](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/unmask). Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints. >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions. > > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | Profile System | Documents | **Get Item** | | Profile System | Documents | **Save and Update Item** | | Profile System | Documents | **Delete Item** | There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - MaskedProspectResponse[] — List of masked prospects. - `id` string — ID of the prospect. - `document` Prospect — Prospect information. - `availableAddresses` object[] — Available addresses. - `disposable` boolean — Defines whether the address is deleted after use (`true`) or not (`false`). - `userId` string — User unique identifier. - `addressName` string — Address name. - `addressType` string — Address type. - `postalCode` string — Postal code. - `city` string — City. - `country` string — Country code. - `street` string — Street name. - `number` string — Street number. - `complement` string — Complement information. - `geoCoordinate` string[] — Array with two strings that represent geocoordinates: first latitude, then longitude. - `paymentData` PaymentData — Payment data. - `availableAccounts` object[] — List of available payment accounts. - `accountId` string — Payment account ID. - `paymentSystem` string — Payment system code. - `paymentSystemName` string — Payment system name. - `cardNumber` string — Masked card number. - `bin` string — Card bin. - `availableAddresses` string[] — List of available addresses. - `expirationDate` string — Card expiration date, in `MM/YYYY` format. - `isExpired` boolean — Defines if the card is expired (`true`) or not (`false`). - `accountStatus` string, nullable — Account status. - `availableTokens` string[] — Available tokens. - `transactions` object[], nullable — List of transactions. - `isActive` boolean, required — Indicates whether the transaction is active (`true`) or not (`false`). - `transactionId` string, required — Transaction ID. - `merchantName` string, required — Merchant name. - `payments` Payment[], required — List of payments information. - `id` string, required — Payment ID. - `paymentSystem` string, required — Payment system. - `paymentSystemName` string, required — Payment system name. - `value` integer, required — Payment value in cents. - `installments` integer, required — Payment installments. - `referenceValue` integer, required — Reference value for interest calculation in cents. - `cardHolder` string, nullable, required — Card holder. - `cardNumber` string, nullable, required — Card number. - `firstDigits` string, nullable, required — Card first digits. - `lastDigits` string, nullable, required — Card last digits. - `cvv2` string, nullable, required — Card verification code. - `expireMonth` string, nullable, required — Card expiration month. - `expireYear` string, nullable, required — Card expiration year. - `url` string, required — Payment URL. - `giftCardId` string, nullable, required — Gift card ID. - `giftCardName` string, nullable, required — Gift card name. - `giftCardCaption` string, nullable, required — Gift card caption. - `redemptionCode` string, nullable, required — Redemption code. - `group` string, required — Payment group. - `tid` string, nullable, required — Payment TID. - `dueDate` string, required — Due date. - `connectorResponses` object, required — Connector responses. - `giftCards` string[] — Gift card IDs. - `giftCardMessages` string[] — Gift card messages. - `numberOfPaymentErrors` number — Amount of payment errors. - `numberOfDeniedTransactions` number — Amount of denied transactions. - `lastDeniedTransaction` string, nullable — Last denied transaction. - `contacts` object[] — List of contacts. - `contactId` string — Contact's unique identifier. - `email` string — Contact's email address. - `firstName` string — Contact's first name. - `lastName` string — Contact's last name. - `phone` string — Contact's phone number. - `document` string — Contact's document. - `invoiceSubject` object — Information about the invoice subject. - `invoiceSubjectId` string — Invoice subject ID. - `email` string — Invoice subject's email address. - `firstName` string — Invoice subject's first name. - `lastName` string — Invoice subject's last name. - `phone` string — Invoice subject's phone number. - `email` string — Prospect's email address. - `firstName` string — Prospect's first name. - `lastName` string — Prospect's last name. - `document` string — Prospect's document. - `cellPhone` string — Prospect's cellphone number. - `isPJ` boolean — Defines if a prospect is corporate (`true`) or not (`false`). - `customerCode` string — Prospect's customer code. - `meta` ProspectMeta — Prospect information metadata. - `version` string, required — Unique identifier of the prospect version. - `author` string, required — Unique identifier of the user who created the prospect. - `creationDate` string, required — Date when the prospect information was created in ISO 8601 format. - `lastUpdateDate` string, required — Date when the prospect information was last updated in ISO 8601 format. - `expirationDate` string, nullable — Date when the prospect information expires in ISO 8601 format. --- [API](https://skmtc.net/vtex/apis/profile-system-pii-data-architecture.md) · [All operations](https://skmtc.net/vtex/apis/profile-system-pii-data-architecture/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/profile-system-pii-data-architecture/versions/23729fa2a727/schema)