v3

latestSwagger 2.02026-08-067506752.0 MB

field

Return all fields in the organization paginated

get/v1/org/{orgId}/field

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fromstring

Field id to start paginating from

limitinteger

Number of results to return

idsstring

Comma separated Field Ids to find

tablestring

Retrieve fields from a particular table (id or name); if not passed, returns non-table fields

tableTypestring

Retrieve fields from a particular table type; ignored if table not passed

formstring

Retrieve fields relating to a particular form

builtinstring

Include built-in (builtin), custom (custom) or all fields - defaults to custom

includeTtstboolean

Include custom ttst fields - defaults to false

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "name": "summary",
      "label": "Job Summary",
      "description": "This field tracks the most recent performance rating for an individual.",
      "expr": "(base + variable) / 12",
      "values": [
        {
          "id": "588f7ee98f138b19220041a7"
        }
      ],
      "groupTypeId": "588f7ee98f138b19220041a7",
      "categoryId": "588f7ee98f138b19220041a7",
      "categoryIds": [
        "588f7ee98f138b19220041a7"
      ],
      "tableId": "588f7ee98f138b19220041a7",
      "tableRef": {
        "tableId": "588f7ee98f138b19220041a7"
      },
      "createId": "588f7ee98f138b19220041a7",
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ]
}