/lookup/{table}/{field}

GET /lookup/{table}/{field}

Get lookup options

Retrieves lookup options for a specific table and field. The user must have access to the account.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for multi-tenant context

table path string

The table name to look up options for

field path string

The field name to look up options for

Try it out

Output:

Responses

Description

Successful response

[
  {
    "id": 0,
    "text": "string",
    "value": "string",
    "displayOrder": 0,
    "metadata": {},
    "parent_id": 0,
    "custom_sort_index": 0,
    "group_name": "string",
    "locale": "string",
    "description": "string",
    "is_active": false,
    "expires_at": "string"
  }
]

Description

Bad request - invalid table or field names

{
  "error": "string",
  "status": 0
}

Description

Internal server error

{
  "error": "string",
  "status": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/LookupOption #/components/schemas/Error

in: header
name: x-account-id
schema:
  type: string
description: Account ID for multi-tenant context
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/LookupOption

OpenAPI
TypeScript

type: object
description: Lookup option for a specific table/field combination
properties:
  id:
    type: integer
    description: Unique identifier for the lookup option
  text:
    type: string
    description: Display text for the lookup option
  value:
    type: string
    description: Internal value of the lookup option
  displayOrder:
    type: integer
    description: Order in which the option should be displayed
  metadata:
    type: object
    description: Additional data associated with the lookup option
  parent_id:
    type: integer
    description: ID of the parent lookup option if this is a child option
  custom_sort_index:
    type: integer
    description: Custom index for sorting the lookup options
  group_name:
    type: string
    description: Group name for organizing lookup options
  locale:
    type: string
    description: Locale code for internationalization
  description:
    type: string
    description: Detailed description of the lookup option
  is_active:
    type: boolean
    description: Whether the lookup option is active
  expires_at:
    type: string
    format: date-time
    description: Expiration date and time for the lookup option
required:
  - id
  - value

|
export interface LookupOption {
  /** Unique identifier for the lookup option */
  id: number;
  /** Display text for the lookup option */
  text?: string;
  /** Internal value of the lookup option */
  value: string;
  /** Order in which the option should be displayed */
  displayOrder?: number;
  /** Additional data associated with the lookup option */
  metadata?: {};
  /** ID of the parent lookup option if this is a child option */
  parent_id?: number;
  /** Custom index for sorting the lookup options */
  custom_sort_index?: number;
  /** Group name for organizing lookup options */
  group_name?: string;
  /** Locale code for internationalization */
  locale?: string;
  /** Detailed description of the lookup option */
  description?: string;
  /** Whether the lookup option is active */
  is_active?: boolean;
  /** Expiration date and time for the lookup option */
  expires_at?: Date;
}

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
required:
  - error
description: Error response object

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /lookup/[table]/[field]/route.ts

Or the swagger.yaml spec this documentation was generated from: /lookup/swagger.yaml