Field Type Queries

Get a list of fields, field count or even a details of a specific field type using a query operator. The query operator for fetching field types on the board and it works with different operation names like fields,
fieldsCount and fieldById

Arguments

boardId !String	This is a unique identifier for a board
fieldId !String	This is a unique identifier for a field type

Fetch Fields in a Board

operation name : fields

This allows you to fetch a list of fields that exist on a board and it takes fields as operation name. With the operation, you get to see the Field type ids and other properties of all field types that exists on the board.

GraphQL

query{
    fields(boardId:"615be38975138d0001c501a7"){
        id
        fieldsSecret{
            name
            description
            type
            unique
            defaultValue
        }
        childField
        nameHash
        boardId
        createdTime
        lastModifiedTime
        isVisibleOnTable
        isVisibleOnForm
        position
        isLocked
    }
}

Sample Response

{
    "data": {
        "fields": [
            {
                "id": "615be3a275138d0001c501a9",
                "fieldsSecret": {
                    "name": "Company Name",
                    "description": null,
                    "type": "shortText",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "E7B47C58815ACF1D3AFA59A84B5DB7FB",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 05:33:22 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 1,
                "isLocked": false
            },
            {
                "id": "615be3b9ee3a6e0001310201",
                "fieldsSecret": {
                    "name": "Website",
                    "description": null,
                    "type": "link",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "15BBB9D0BBF25E8D2978DE1168C749DC",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 05:33:45 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 2,
                "isLocked": false
            },
            {
                "id": "615be5e5ee3a6e0001310203",
                "fieldsSecret": {
                    "name": "Email",
                    "description": null,
                    "type": "email",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "CE8AE9DA5B7CD6C3DF2929543A9AF92D",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 05:43:01 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 3,
                "isLocked": false
            },
            {
                "id": "615be5fe75138d0001c501ab",
                "fieldsSecret": {
                    "name": "Multi-options",
                    "description": null,
                    "type": "checkbox",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "FF1749FBBBEC45F58D7D9B9CC6F6CFC4",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 05:43:26 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 4,
                "isLocked": false
            },
            {
                "id": "615bea0dee3a6e000131020a",
                "fieldsSecret": {
                    "name": "Num",
                    "description": null,
                    "type": "number",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "B3E3076D9B3C53BEDE50D468B647B109",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 06:00:45 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 5,
                "isLocked": false
            },
            {
                "id": "615c3177ee3a6e0001310227",
                "fieldsSecret": {
                    "name": "Status",
                    "description": null,
                    "type": "dropdown",
                    "unique": false,
                    "defaultValue": null
                },
                "childField": null,
                "nameHash": "EC53A8C4F07BAED5D8825072C89799BE",
                "boardId": "615be38975138d0001c501a7",
                "createdTime": "Tue Oct 05 11:05:27 GMT 2021",
                "lastModifiedTime": null,
                "isVisibleOnTable": true,
                "isVisibleOnForm": false,
                "position": 6,
                "isLocked": false
            }
        ]
    }
}

Fetch number of Field Types in a Board

operation name : fieldsCount

Here, you fetch the total number of field type that exist in a board. That works irrespective of the type of field and mainly returns an integer value.
To perform this query operation, you need to pass boardId as an argument.

GraphQL

query{
    fieldsCount(boardId:"615be38975138d0001c501a7")
}

Sample Response

{
    "data": {
        "fieldsCount": 6
    }
}

Fetch a specific field type by id

operation name : fieldById

Here you can look up a specific field type and all associated properties such as the name, types, uniqueness and other properties.
To perform this operation, you do need to pass the fieldId as an argument.

GraphQL

query{
    fieldById(fieldId:"615be3a275138d0001c501a9"){
        id
        fieldsSecret{
            name
            description
            type
            unique
            defaultValue
        }
        childField
        nameHash
        boardId
        createdTime
        lastModifiedTime
        isVisibleOnTable
        isVisibleOnForm
        position
        isLocked
    }
}

Sample Response

{
    "data": {
        "fieldById": {
            "id": "615be3a275138d0001c501a9",
            "fieldsSecret": {
                "name": "Company Name",
                "description": null,
                "type": "shortText",
                "unique": false,
                "defaultValue": null
            },
            "childField": null,
            "nameHash": "E7B47C58815ACF1D3AFA59A84B5DB7FB",
            "boardId": "615be38975138d0001c501a7",
            "createdTime": "Tue Oct 05 05:33:22 GMT 2021",
            "lastModifiedTime": "Sat Oct 09 11:41:55 GMT 2021",
            "isVisibleOnTable": true,
            "isVisibleOnForm": false,
            "position": 1,
            "isLocked": false
        }
    }
}