Record Queries

Record query operation allows to read record items from a board, field

Endpoint

https://api.quabbly.live/v1/api

Header

x-api-key : "API Key"

Arguments

Field Name	Value	Type
recordId	String	String
boardId	String	String

Get Record by Id

Operator name: record

Record by Id: Structure

query record ($boardId: String, $recordId: String) {
    record (boardId: $boardId, recordId: $recordId) {
        id
        createdTime
        lastUpdatedTime
        lastUpdatedBy
        userName
        data {
            fieldId
            value
            values
        }
    }
}

Sample Payload

query{
    record(boardId: "645be3a275138d0001c501b6", recordId:"615be3a275138d0001c501a9"){
        id
        createdTime
        lastUpdatedTime
        lastUpdatedBy
        userName
        data {
            fieldId
            value
            values
        }

Sample Response

{
  "id": "61f2aca387c6e40001d90cbf",
  "createdTime": 1643293859775,
  "lastUpdatedBy": null
  "lastUpdatedTime": null
  "userName": "david.adediji@quabbly.com"
  "data" : [
    {
    "fieldId" : "61f115ca87c6e40001d90c74",
    "value" : "a ",
    "values" : null
    },
    "fieldId" : "61d115ca87c6e40001d90c75",
    "value" : null,
    "values" : ["good", "evil"]
    },
    "fieldId" : "61efeb2615c81700011c5adf",
    "value" : "Public api",
    "values" : null
    },
    "fieldId" : "61f115ca87c6e40001d90c74",
    "value" : null,
    "values" : ["2022-01-20"]
    },
    "fieldId" : "61f115ca87c6e40001d90c79",
    "value" : "https://s3.eu-wes.png",
    "values" : null
    },
    "fieldId" : "61g115ca87c6e40001d90c41",
    "value" : "102273, Lagos, Nigeria",
    "values" : null
    },
     },
    "fieldId" : "61h115ca87c6e40001d90c43",
    "value" : "09032484389",
    "values" : null
    }
  ]
}

Get Record by BoardId

Operator name: boardRecords

Record by Id: Structure

query  {
    boardRecords(boardId: $boardId) {
        id
        data {
            fieldId
            value
            values
        }
    }
}

Sample Payload

query  {
    boardRecords(boardId: "614da71748f8a60001a9c095") {
        id
        data {
            fieldId
        }
    }
}

Sample Response

{
  "data" : {
    "records" : [
      {
      id": "61f2aca387c6e40001d90cbf",
      "data" : [
        {"fieldId" : "61f115ca87c6e40001d90c74"},
        {"fieldId" : "61d115ca87c6e40001d90c75"},
        {"fieldId" : "61g115ca87c6e40001d90c41"}
        ]
      },
      {
      id": "61f2aca387c6e40001d90cbf",
      "data" : [
        {"fieldId" : "61f115ca87c6e40001d90c74"},
        {"fieldId" : "61d115ca87c6e40001d90c75"},
        {"fieldId" : "61g115ca87c6e40001d90c41"}
        ]
      },
      {
      id": "61f2aca387c6e40001d90cbf",
      "data" : [
        {"fieldId" : "61f115ca87c6e40001d90c74"},
        {"fieldId" : "61d115ca87c6e40001d90c75",},
        {"fieldId" : "61g115ca87c6e40001d90c41"}
        ]
      }
    ]
  }

Get Number of Records By Board Id

Operator name: recordCount

Record Count by BoardId: Structure

query recordCount ($boardId: String) {
    recordCount (boardId: $boardId)
}

Sample Payload

query {
    recordCount (boardId: "61f2d00c8593ff00014512b0")
}

Sample Response

{
    "data": {
        "recordCount": 6
    }
}

Updated almost 3 years ago

Did this page help you?