list-ulFields

Retrieve all fields

get

Retrieve all fields in a workspace.

Responses
chevron-right
200

All fields in a workspace.

application/json
idstringRequired

The ID of the field.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
workspace_idstringRequired

The ID of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
keystringRequired

The field's key.

Example: company_name
namestringRequired

The field's name.

Example: Company Name
typestring · enumRequired

The type of the field.

Possible values:
detailsobjectRequired

Extra information about the field.

created_atstring · date-timeRequired

Timestamp of when the field was created.

Example: 2025-01-01T00:00:00.000Z
updated_atstring · date-timeRequired

Timestamp of when the field was last updated.

Example: 2025-01-01T00:00:00.000Z
get
/fields

Retrieve a field by ID

get

Retrieve a field by its ID.

Responses
chevron-right
200

A field.

application/json
idstringRequired

The ID of the field.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
workspace_idstringRequired

The ID of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
keystringRequired

The field's key.

Example: company_name
namestringRequired

The field's name.

Example: Company Name
typestring · enumRequired

The type of the field.

Possible values:
detailsobjectRequired

Extra information about the field.

created_atstring · date-timeRequired

Timestamp of when the field was created.

Example: 2025-01-01T00:00:00.000Z
updated_atstring · date-timeRequired

Timestamp of when the field was last updated.

Example: 2025-01-01T00:00:00.000Z
get
/fields/{fieldId}

Create a new field

post

Create a new custom field.

Body
keystringRequired

The field's key, used for internal purposes.

Example: company_name
namestringRequired

The field's name, used for display purposes.

Example: Company Name
typestring · enumRequired

The type of the field.

Possible values:
Responses
post
/fields

Update a field

patch

Update a field.

Body
objectOptional
Responses
chevron-right
200

The field that was updated.

application/json
idstringRequired

The ID of the field.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
workspace_idstringRequired

The ID of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
keystringRequired

The field's key.

Example: company_name
namestringRequired

The field's name.

Example: Company Name
typestring · enumRequired

The type of the field.

Possible values:
detailsobjectRequired

Extra information about the field.

created_atstring · date-timeRequired

Timestamp of when the field was created.

Example: 2025-01-01T00:00:00.000Z
updated_atstring · date-timeRequired

Timestamp of when the field was last updated.

Example: 2025-01-01T00:00:00.000Z
patch
/fields/{fieldId}

Delete a field

delete

Delete a field.

Responses
chevron-right
200

The field that was deleted.

application/json
idstringRequired

The ID of the field.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
workspace_idstringRequired

The ID of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
keystringRequired

The field's key.

Example: company_name
namestringRequired

The field's name.

Example: Company Name
typestring · enumRequired

The type of the field.

Possible values:
detailsobjectRequired

Extra information about the field.

created_atstring · date-timeRequired

Timestamp of when the field was created.

Example: 2025-01-01T00:00:00.000Z
updated_atstring · date-timeRequired

Timestamp of when the field was last updated.

Example: 2025-01-01T00:00:00.000Z
delete
/fields/{fieldId}

Last updated