Fields

List Fields

Required scopes: field (Read only).

get/fields

Request

Query parameters

searchstring

Search fields by slug or name

entity'project' | 'user' | 'task' | 'file' | 'translation' | 'string' | 'term' | 'concept'

Filter fields by entity

type'checkbox' | 'radiobuttons' | 'date' | 'datetime' | 'number' | 'labels' | 'select' | 'multiselect' | 'text' | 'textarea' | 'url'

Filter fields by type

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Fields list

Example response

{
  "data": [
    {
      "data": {
        "id": 2,
        "name": "Custom field",
        "slug": "custom-field",
        "description": "Custom field description",
        "type": "select",
        "entities": [
          "task"
        ],
        "createdAt": "2019-09-23T09:04:29+00:00",
        "updatedAt": "2019-09-23T09:04:29+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25,
    "total": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.