Get index by name in VTEX Master Data

What this operation does

Get index by name

• GETReads data · Indicesvtex.local/api/dataentities/{dataEntityName}/indices/{index_name}

How HumDay uses it

1. You describe the outcome. Not this operation by name — what you want to happen. HumDay works out which operations it needs.
2. The contract names it. Before anything is built, you see exactly which VTEX Master Data operations the program may use, and this is one of them.
3. You approve access. Read-only access is still yours to grant, and still limited to what the contract needs.

Other VTEX Master Data operations

• Create new customer profilePOST · changes data
• Create new customer addressPOST · changes data
• Create new documentPOST · changes data
• Create partial documentPATCH · changes data
• Delete customer profileDELETE · changes data
• Update customer profilePATCH · changes data
• Delete customer addressDELETE · changes data
• Update customer addressPATCH · changes data

All 26 VTEX Master Data operations

Questions

Can HumDay get index by name in VTEX Master Data?

Yes. This operation is published in VTEX Master Data's own API description, so HumDay can use it without a hand-built connector — once you have approved it for your automation.

Does this change anything in my VTEX Master Data account?

No. This is a read-only operation, so it can be used to watch for changes or fetch data without altering anything in VTEX Master Data.

Do I need to write code?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a proof run before anything touches your VTEX Master Data account.

Where this came from

Read from a published API description for VTEX Master Data at raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Master Data API - v2.json. The description above is the provider’s own wording, not ours. Last published 2023-03-03.