Skip to main content

Record API

You will be able to manage records in your tables with this API

API​

Add a record​

Description:​
  • Allows you to add a record into a table.

POST​

/v1/crm/core/table/{tableId}/record​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record
Curl​
curl -X POST "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '{"cells":{"Uvhr":"My contact new","JofH":"my.contact.new@deskera.xyz","VKQV":[1],"HLsw":[1,7661]}}'
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
RecordRequestbodyRecordRequestYesRecordRequest
Sample Request​
Click to expand/collapse
{
  "cells": {
    "Uvhr": "My contact new",
    "JofH": "my.contact.new@deskera.xyz",
    "VKQV": [
      1
    ],
    "HLsw": [
      1,
      7661
    ]
  }
}
Sample Response​
Click to expand/collapse
{
    "success": true,
    "id": "626a161631e99d00135282a4",
    "data": {
    "_id": "626a161631e99d00135282a4",
        "cells": {
            "Uvhr": "My contact new",
            "JofH": "my.contact.new@deskera.xyz",
            "VKQV": [
                1
            ],
            "HLsw": [
                1,
                7661
            ],
            "iPz8": "2022-04-28T04:20:38.262Z",
            "a2vj": "WEB",
            "Fvks": [
                231183
            ]
        },
        "permissions": {
            "owners": [
                "231183"
            ]
        },
        "createdBy": 231183,
        "createdAt": "2022-04-28T04:20:38.262Z",
        "updatedAt": "2022-04-28T04:20:38.262Z"
    }
}
Responses​
CodeDescriptionSchema
201OKRecordCUResponse
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

List records​

Description:​
  • Allows you to list records from a table with pagination and filter.

POST​

/v1/crm/core/table/{tableId}/paged-record​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/paged-record?q=searchstring&pageNo=1&pageSize=2&sortCol=createdAt
Curl​
curl -X POST "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/paged-record?q=searchstring&pageNo=1&pageSize=2&sortCol=createdAt" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '{"logicalOperator":"or","conditions":[{"colId":"Uvhr","opr":"eq","value":"my contact name"},{"colId":"JofH","opr":"sw","value":"my-prefix"}]}'
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
FilterRequestbodyFilterYesFilterRequest
qqueryvalue to perform full-text-search in recordsNostring
pageNoqueryPage Number. Default Value: 1Nointeger
pageSizequeryPage Size. Default Value: 30Nointeger
sortColquerycolumn id to sort record by. Default Value: createdAtNostring
sortDirquerySort Direction. Default Value: -1NoSortDirection
fetchAllRefqueryPass true to populate details of all ref columns. Default Value: falseNoboolean
colIdsToFetchRefqueryComma separated IDs of columns to populate ref column details. fetchAllRef has higher preference.Nostring
Sample Request​
Click to expand/collapse
{
  "logicalOperator": "or",
  "conditions": [
    {
      "colId": "Uvhr",
      "opr": "eq",
      "value": "my contact name"
    },
    {
      "colId": "JofH",
      "opr": "sw",
      "value": "my-prefix"
    }
  ]
}
Sample Response​
Click to expand/collapse
{
  "totalCount": 100818,
  "sortCol": "createdAt",
  "sortDir": -1,
  "pageNo": 1,
  "pageSize": 2,
  "data": [
    {
      "_id": "551cfe9828d7b600b99c7b22",
      "cells": {
        "Uvhr": "My contact 1",
        "VKQV": [
          1
        ],
        "HLsw": [
          1
        ],
        "iPz8": "2022-04-26T11:52:46.848Z",
        "KvRO": "India",
        "a2vj": "WEB",
        "Fvks": [
          231183
        ]
      },
      "permissions": {
        "owners": [
          "231183"
        ]
      },
      "createdBy": 231183,
      "createdAt": "2022-04-26T11:52:46.848Z",
      "updatedAt": "2022-04-26T11:52:46.848Z"
    },
    {
      "_id": "a64b63c66506d2717fbc2dfd",
      "cells": {
        "Uvhr": "My contact 2",
        "VKQV": [
          1
        ],
        "HLsw": [
          1
        ],
        "iPz8": "2022-04-26T11:52:34.119Z",
        "a2vj": "WEB",
        "Fvks": [
          231183
        ]
      },
      "permissions": {
        "owners": [
          "231183"
        ]
      },
      "createdBy": 231183,
      "createdAt": "2022-04-26T11:52:34.120Z",
      "updatedAt": "2022-04-26T11:52:35.000Z"
    }
  ]
}
Responses​
CodeDescriptionSchema
200OKPagedRecordResponse
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

Get record by ID​

Description:​
  • Allows you to get a record from a table by its unique id.

GET​

/v1/crm/core/table/{tableId}/record/{recordId}​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/551cfe9828d7b600b99c7b22
Curl​
curl -X GET "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/551cfe9828d7b600b99c7b22" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
recordIdpathUnique id of recordYesstring
Sample Response​
Click to expand/collapse
{
  "_id": "551cfe9828d7b600b99c7b22",
  "cells": {
    "Uvhr": "My contact 1",
    "VKQV": [
      1
    ],
    "HLsw": [
      1
    ],
    "iPz8": "2022-04-26T11:52:46.848Z",
    "KvRO": "India",
    "a2vj": "WEB",
    "Fvks": [
      231183
    ]
  },
  "permissions": {
    "owners": [
      "231183"
    ]
  },
  "createdBy": 231183,
  "createdAt": "2022-04-26T11:52:46.848Z",
  "updatedAt": "2022-04-26T11:52:46.848Z"
}
Responses​
CodeDescriptionSchema
200OKRecord
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

Get record count​

Description:​
  • Allows you to get total record count from a table.

GET​

/v1/crm/core/table/{tableId}/count​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/count
Curl​
curl -X GET "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/count" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
Sample Response​
Click to expand/collapse
{
    "count": 100819
}
Responses​
CodeDescriptionSchema
200OKRecordCountResponse
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

Update record by ID​

Description:​
  • Allows you to update a record in a table by unique id of the record.

PUT​

/v1/crm/core/table/{tableId}/record/{recordId}​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/626a161631e99d00135282a4
Curl​
curl -X PUT "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/626a161631e99d00135282a4" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '{"cells":{"Uvhr":"My contact new - updated","JofH":"my.contact.new.updated@deskera.xyz","VKQV":[1],"HLsw":[1,7661]}}'
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
recordIdpathUnique id of recordYesstring
RecordRequestbodyRecordRequestYesRecordRequest
Sample Request​
Click to expand/collapse
{
  "cells": {
    "Uvhr": "My contact new - updated",
    "JofH": "my.contact.new.updated@deskera.xyz",
    "VKQV": [
      1
    ],
    "HLsw": [
      1,
      7661
    ]
  }
}
Sample Response​
Click to expand/collapse
{
    "success": true,
    "id": "626a161631e99d00135282a4",
    "data": {
    "_id": "626a161631e99d00135282a4",
        "cells": {
            "Uvhr": "My contact new - updated",
            "JofH": "my.contact.new.updated@deskera.xyz",
            "VKQV": [
                1
            ],
            "HLsw": [
                1,
                7661
            ],
            "iPz8": "2022-04-28T04:20:38.262Z",
            "a2vj": "WEB",
            "Fvks": [
                231183
            ]
        },
        "permissions": {
            "owners": [
                "231183"
            ]
        },
        "createdBy": 231183,
        "createdAt": "2022-04-28T04:20:38.262Z",
        "updatedAt": "2022-04-28T04:31:57.882Z"
    }
}
Responses​
CodeDescriptionSchema
200OKRecordCUResponse
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

Delete record by ID​

Description:​
  • Allows you to delete a record from a table by unique id of the record.

DELETE​

/v1/crm/core/table/{tableId}/record/{recordId}​

Request URL​
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/626a161631e99d00135282a4
Curl​
curl -X DELETE "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/record/626a161631e99d00135282a4" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters​
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
recordIdpathUnique id of recordYesstring
Sample Response​
Click to expand/collapse
{
    "success": true,
    "id": "626a161631e99d00135282a4",
}
Responses​
CodeDescriptionSchema
200OKRecordDeleteResponse
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
ApiKeyAuth

Models​

FilterRequest​

NameTypeDescriptionRequired
logicalOperatorstringlogical operator to join the filter conditions. Possible Values: [and, or]Yes
conditionsList of FilterConditionfilter conditionsNo

FilterCondition​

NameTypeDescriptionRequired
colIdstringColumn idYes
oprFilterOperatorFilter operatorYes
valuestringValue to match in filterYes

FilterOperator​

NameDescription
eqEquals
neqNot Equals
empIs Empty
nempIs Not Empty
ltLess Than
lteLess Than or Equals
gtGreater Than
gteGreater Than or Equals
inIn
ninNot In
swStarts With
ewEnds With
cContains
ncDoes Not Contain

PagedRecordResponse​

NameTypeDescriptionRequired
totalCountintegerTotal record count in tableYes
sortColstringcolumn id to sort record by. Defaults to: createdAtYes
sortDirSortDirectionSort Direction. Defaults to: -1Yes
pageNointegerPage numberYes
pageSizeintegerNumber of records per pageYes
dataList of RecordRecord listYes

SortDirection​

NameDescription
1ASC
-1DESC

Record​

NameTypeDescriptionRequired
_idstringUnique idYes
cellsMap<string, object>All column values in the form of a map, with column id as key and column value as valueYes
permissionsPermissionsPermissions of the users for the recordNo
createdAtstringISO timestampNo
updatedAtstringISO timestampNo
createdByintegeriamUserId of the user who created the recordYes

RecordRequest​

NameTypeDescriptionRequired
cellsMap<string, object>All column values in the form of a map, with column id as key and column value as valueYes

Permissions​

NameTypeDescriptionRequired
ownersList of integerList of iamUserId of users who are owners of the record. Applicable to Contact, Deal, and Activity.Yes

RecordCUResponse​

NameTypeDescriptionRequired
successbooleanSuccess flagYes
idstringid of the recordYes
dataRecordRecordYes

RecordDeleteResponse​

NameTypeDescriptionRequired
successbooleanSuccess flagYes
idstringid of the recordYes

RecordCountResponse​

NameTypeDescriptionRequired
countintegercountYes