Get Fields

get https://api.layer.team/projects/{projectId}/fields

Get all fields in a project. Optionally, a categoryId or viewId can be provided to return fields inside a particular category or view.

Responses

Response body

object

fields

array of objects

List of Layer Fields

fields

object

createdAt

date-time

required

Date & time the field was created

createdBy

string

required

Name of the user who created the field

updatedAt

date-time

required

Date & time the field was last updated

updatedBy

string

required

Name of the user who last updated the field

name

string

required

length ≤ 50

Name of the field

description

string

required

Description of the field

string

required

type

string

required

Field type

area barcode createdat createdby date divider elementNumber email file formula lookup modelView modelName number person phone range references related revitParam select spatialRelationships text toggle versionHistory updatedat updatedby

category

object

required

reCat

object

For auto lookup fields, the category that the autoTarget field is in

color

string

The color of the field in the app

dual

boolean

For range fields, if the upper and lower bounds should be tracked

format

string

The formatting used when the field value is displayed

currency dollar dollarCents feetInches integer number numberCommas percent phone revitUnit text

formula

string

For formula fields, the raw formula used to calculate the field value

lookupType

string

For lookup fields, the type of lookup field configured (automatic or manual)

automatic manual

lookupAggregation

string

For lookup fields, the aggregation type used to calculate the field value

list sum average median min max range countUnique count countEmpty countNotEmpty unique

autoSource

object

For auto lookup fields, the field in the same category as this field to compare against the autoTarget

autoTarget

object

For auto lookup fields, the field in the target category to compare against the autoSource

lookupTarget

object

For auto and manual lookup fields, the field to display as the result of the lookup

lookupField

object

For manual lookup fields, the related element field in the same category as this field to retrieve elements from

max

number

For range fields, the maximum value allowed

min

number

For range fields, the minimum value allowed

step

number

For range fields, size of the step between values

multiple

boolean

For select fields, if multiple options can be selected

options

object

For select fields, the available options to select from

optionValue

boolean

For select fields, if a numerical option value should be set on each option

showOptionValue

boolean

For select fields, if the numerical option value should be displayed

order

number

required

The order the field is displayed within its category

placeholder

string

The placeholder value for the field

sibling

string

For related fields, the ID of the sibling field that is kept in sync with this field

trackQuantity

boolean

For lookup and related fields, if the quantity of the objects in the field should be tracked

200Default Response

4XXDefault Response