Administration

Gold-Vision API

Meta Data

Understanding your data before you query it

The metadata endpoint returns the full field specification for any Gold-Vision entity — field names, display labels, data types, and for dropdown and lookup fields, every available option value. It’s the quickest way to discover what fields exist and what values are valid before building a query.

Endpoint

GET {your-gold-vision-url}/api/cosmos/{entity}/meta

Works for any entity. For example:

GET https://your-instance/api/cosmos/accounts/meta
GET https://your-instance/api/cosmos/opportunities/meta
GET https://your-instance/api/cosmos/activities/meta

What you get back

The response is an array of field definitions. Standard fields look like this:

json
{
  "name": "summary",
  "label": "Account Name",
  "type": "string",
  "editable": true
}

Dropdown and lookup fields include their full list of options:

json
{
  "name": "type1",
  "label": "Account Type",
  "type": "lookup",
  "options": [
    { "id": "3a1f...", "summary": "Customer" },
    { "id": "8bc2...", "summary": "Prospect" }
  ]
}

Tip

Use the metadata endpoint first when building a new integration. The IDs returned in options are the GUIDs you’ll use in filter expressions and when writing records back to Gold-Vision.


Was this article helpful?

Thank you for your feedback