List fields

GET/workspaces/{organizationId}/fields

Path parameters

organizationIdstringrequired

Query parameters

entityTypestring

Responses

200

Field definitions

fieldsobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

entityTypestringrequired

namestringrequired

typestringrequired

Allowed:textnumberselectdateboolean

optionsstring[] | nullrequired

positionnumberrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*entityTypequery

Request

curl -X GET '/workspaces/string/fields'

const response = await fetch("/workspaces/string/fields", {
  method: "GET"
});

import requests

response = requests.get(
    "/workspaces/string/fields",
)

Response

{
  "fields": [
    {
      "id": "string",
      "organizationId": "string",
      "entityType": "string",
      "name": "string",
      "type": "text",
      "options": [
        "string"
      ],
      "position": 0,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}