Get Enum Values

Retrieve the list of valid values for a named Nexudus enumeration type.

GET /api/utils/enums

Get Enum Values

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/utils/enums \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/utils/enums"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/utils/enums', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "Id": 123,
  "Name": "<string>",
  "Label": "<string>",
  "400 Bad Request": {},
  "401 Unauthorized": {}
}

Get Enum Values

Returns all valid values for a named Nexudus enumeration. Enums are used throughout the platform to represent fixed sets of choices — for example, invoice status, resource types, booking states, or delivery status. The portal uses this endpoint to build dropdowns and validate field values dynamically.

Authentication

Requires a valid customer bearer token.

Query Parameters

name · string · required

The name of the enumeration to retrieve. This must match the exact server-side enum name (e.g. "InvoiceStatus", "ResourceType").

Response

Returns an array of enum entry objects. The exact shape depends on the enum requested, but each entry typically includes:

Id · number

Numeric value of the enum entry (as stored in the database).

Name · string

Machine-readable key for the enum entry.

Label · string

Human-readable localised label for display in the UI.

Example Response

[
  { "Id": 1, "Name": "Draft", "Label": "Draft" },
  { "Id": 2, "Name": "Sent", "Label": "Sent" },
  { "Id": 3, "Name": "Paid", "Label": "Paid" },
  { "Id": 4, "Name": "Cancelled", "Label": "Cancelled" }
]

TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.enum('InvoiceStatus')
// => '/api/utils/enums?name=InvoiceStatus'

const response = await httpClient.get<{ Id: number; Name: string; Label: string }[]>(url)
const enumValues = response.data

Usage in Portal

Context	Source file
Dynamic dropdowns for resource fields	src/views/bookings/
Checkout and product configuration	src/views/checkout/

Error Responses

400 Bad Request · error

The name parameter is missing or does not match a known server-side enum.

401 Unauthorized · error

The bearer token is missing, expired, or invalid.

Related Endpoints

Method	Endpoint	Description
GET	/api/public/configuration	Get full portal configuration including settings
GET	/api/public/resources/fields/searchable	Get searchable custom fields for resources