Developers › API reference › User-defined fields

GET `/api/v1/udf/{table}`

The ten user-defined field definitions of a table.

Scope reference:read
operationId referenceUdfDefs

The token needs the scope reference:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/udf/{table}

Path parameters

Name	Description	Example
`table`	The reference table: securities, issuers, accounts, account_groups, brokers, models, benchmarks, desks or list_entries.	`securities`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/udf/securities" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/udf/securities",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/udf/securities", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: UdfDefList. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`table`	string	The reference table: securities, issuers, accounts, account_groups, brokers, models, benchmarks, desks, list_entries.
`data`	list of UdfDef	The records of this page or list.
`data[].slot`	any	The slot number, 1 to 10.
`data[].column`	string	The database column behind the slot (udf_1 … udf_10).
`data[].active`	any	Whether it is in use.
`data[].name`	any	The name.
`data[].description`	any	A description in plain words.
`data[].type`	any	The type.
`data[].max_length`	any	Maximum length for text.
`data[].precision`	any	Total digits for decimals.
`data[].scale`	any	Digits after the decimal point.
`data[].required`	any	Whether a value is required.
`data[].default`	any	The value used when none is given.
`data[].min`	any	Minimum allowed value.
`data[].max`	any	Maximum allowed value.
`data[].pattern`	any	A pattern text values must match.
`data[].options`	any	The list's options, in order.
`data[].flags`	object	Where the field appears: forms, searchable, blotter, compliance, workflow.
`data[].version`	any	Version number.
`data[].updated_at`	date-time or null	When it last changed.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "table": "securities",
    "data": [
        {
            "slot": 1,
            "column": "udf_1",
            "active": true,
            "name": null,
            "description": "",
            "type": null,
            "max_length": null,
            "precision": null,
            "scale": null,
            "required": false,
            "default": null,
            "min": null,
            "max": null,
            "pattern": null,
            "options": null,
            "flags": {
                "forms": true,
                "searchable": true,
                "blotter": true
            },
            "version": 1,
            "updated_at": "2026-10-27T14:30:00Z"
        }
    ]
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/udf/securities"
}

On the screens

The same thing in the app is explained in:

User-defined fields