Fields

Retrieve all fields

get

Retrieve all fields in a workspace.

Responses

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

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get/fields

GET /api/v1/fields HTTP/1.1
Accept: */*

[
  {
    "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
    "workspace_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
    "key": "company_name",
    "name": "Company Name",
    "type": "TEXT",
    "details": {},
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Retrieve a field by ID

get

Retrieve a field by its ID.

Responses

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

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get/fields/{fieldId}

GET /api/v1/fields/{fieldId} HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "workspace_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "key": "company_name",
  "name": "Company Name",
  "type": "TEXT",
  "details": {},
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

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

201

The field that was created.

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

400

Data is invalid or malformed.

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

409

A field with the specified key already exists.

post/fields

POST /api/v1/fields HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "key": "company_name",
  "name": "Company Name",
  "type": "TEXT"
}

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "workspace_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "key": "company_name",
  "name": "Company Name",
  "type": "TEXT",
  "details": {},
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Update a field

patch

Update a field.

Body

object · UpdateFieldDtoOptional

Responses

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

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

patch/fields/{fieldId}

PATCH /api/v1/fields/{fieldId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "workspace_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "key": "company_name",
  "name": "Company Name",
  "type": "TEXT",
  "details": {},
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Delete a field

delete

Delete a field.

Responses

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

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

delete/fields/{fieldId}

DELETE /api/v1/fields/{fieldId} HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "workspace_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "key": "company_name",
  "name": "Company Name",
  "type": "TEXT",
  "details": {},
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}