Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Your Moonbase API key.

Path Parameters

collection_id
string
required

The ID or ref of the Collection the field belongs to.

id
string
required

The ID or ref of the Field to retrieve.

Response

Successful response.

A field definition, which varies by type

type
string
required

The data type of the field. Always field/text/single_line for this field.

Allowed value: "field/text/single_line"
id
string
required

Unique identifier for the object.

name
string
required

The human-readable name of the field (e.g., "Company Name").

ref
string
required

A unique, stable, machine-readable identifier for the field within its collection (e.g., company_name).

cardinality
enum<string>
required

Specifies whether the field can hold a single value (one) or multiple values (many).

Available options:
one,
many
required
boolean
required

If true, this field must have a value.

unique
boolean
required

If true, values for this field must be unique across all items in the collection.

readonly
boolean
required

If true, the value of this field is system-managed and cannot be updated via the API.

kind
enum<string>
required

system fields are managed by Moonbase, inverse fields are the reverse side of a two-way relation, and custom fields are user-created.

Available options:
system,
inverse,
custom
created_at
string<date-time>
required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

updated_at
string<date-time>
required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

default_values
(Single Line Text · object | Multi Line Text · object | Identifier · object | Integer · object | Float · object | Monetary · object | Percentage · object | Boolean · object | Email · object | URL · object | Domain · object | X · object | LinkedIn · object | Telephone Number · object | Geo · object | Date · object | CurrentDate · object | Date Time · object | CurrentDatetime · object | Choice · object | Funnel Step · object | Relation · object | CurrentMember · object)[]
required

A default value for a field. Can be a static value (e.g., value/date) or a server-resolved value (e.g., current_date). Static values use the same shape as item values. Server-resolved values are computed when an item is created.

description
string

An optional, longer-form description of the field's purpose.