Records

This API allows users to create, retrieve, and manage records that are fully customizable and dynamically configured in the dashboard. Records can store various types of structured data, enabling flexible integrations and workflows tailored to specific business needs.

Create a new record in a table

post
/tables/{tableId}/records

Create a new record in a table

Authorizations
Path parameters
tableIdstringRequired

Identifier of the table to create the record in

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
datestring | nullableOptional

Date field

idFieldstring | nullableOptional

Identifier field in UUID format

numbernumber | nullableOptional

Number field

datetimestring | nullableOptional

DateTime field

checkboxboolean | nullableOptional

Boolean field

jsonobject | nullableOptional

JSON field with arbitrary data

assigneestring | nullableOptional

Assigned user ID

textstring | nullableOptional

Text field

integernumber | nullableOptional

Integer field

singleSelectstring | nullableOptional

Select field option

Responses
201

201

application/json;charset=UTF-8
post
/tables/{tableId}/records
POST /tables/{tableId}/records HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 24

{
  "json": {
    "key": "value"
  }
}
{
  "createdAt": "2025-09-01T16:40:01.776859+02:00",
  "json": {
    "key": "value"
  },
  "id": "cfa6195d-f608-4d1d-8d25-8e2d0bb93973",
  "version": 1,
  "updatedAt": "2025-09-01T16:40:01.776859+02:00"
}

Get a record by ID

get
/tables/{tableId}/records/{id}

Get a record by ID

Authorizations
Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to retrieve

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Responses
200

200

application/json;charset=UTF-8
get
/tables/{tableId}/records/{id}
GET /tables/{tableId}/records/{id} HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: text
Accept: */*
{
  "createdAt": "2025-09-01T16:40:03.595825+02:00",
  "json": {
    "key": "value"
  },
  "id": "22384bab-d7a2-43ec-9151-ffac8632c4fb",
  "version": 1,
  "updatedAt": "2025-09-01T16:40:03.595825+02:00"
}

Delete multiple records in batch

post
/tables/{tableId}/records/delete-batch

Delete multiple records in batch

Authorizations
Path parameters
tableIdstringRequired

Identifier of the table containing the records

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Bodyone of[]

Array of record IDs to delete

itemsone ofOptional
objectOptional
or
booleanOptional
or
stringOptional
or
numberOptional
Responses
204

204

No content

post
/tables/{tableId}/records/delete-batch
POST /tables/{tableId}/records/delete-batch HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 40

[
  "8362495f-5124-4b98-9268-51833d7e9e79"
]

No content

Search records in a table

post
/tables/{tableId}/records/search

Search records in a table

Authorizations
Path parameters
tableIdstringRequired

Identifier of the table to search records in

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
viewstring | nullableOptional

Optional view ID to filter records

pageNumbernumberRequired

Page number (0-based)

pageSizenumberRequired

Number of records per page

Responses
200

200

application/json;charset=UTF-8
post
/tables/{tableId}/records/search
POST /tables/{tableId}/records/search HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 294

{
  "filters": {
    "filters": [
      {
        "fieldId": "12f95373-7413-4d37-be4a-b691f827e6f4",
        "operator": "CONTAINS",
        "value": "value",
        "type": "JSON"
      }
    ],
    "groups": [],
    "conjunction": "OR"
  },
  "pageSize": 5,
  "pageNumber": 1,
  "view": null,
  "search": null,
  "orderBy": [
    {
      "fieldId": "12f95373-7413-4d37-be4a-b691f827e6f4",
      "direction": "ASC"
    }
  ]
}
{
  "content": [],
  "pageable": {
    "pageNumber": 1,
    "pageSize": 5,
    "sort": {
      "empty": false,
      "unsorted": false,
      "sorted": true
    },
    "offset": 5,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalElements": 1,
  "totalPages": 1,
  "first": false,
  "size": 5,
  "number": 1,
  "sort": {
    "empty": false,
    "unsorted": false,
    "sorted": true
  },
  "numberOfElements": 0,
  "empty": true
}

Delete a record by ID

delete
/tables/{tableId}/records/{id}

Delete a record by ID

Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to delete

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Responses
204

204

No content

delete
/tables/{tableId}/records/{id}
DELETE /tables/{tableId}/records/{id} HTTP/1.1
Host: api.sandbox.transactionlink.io
Content-Type: text
Authorization: text
Accept: */*

No content

Update an existing record by ID

patch
/tables/{tableId}/records/{id}

Update an existing record by ID

Authorizations
Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to update

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
datestring | nullableOptional

Date field

idFieldstring | nullableOptional

Identifier field in UUID format

numbernumber | nullableOptional

Number field

datetimestring | nullableOptional

DateTime field

checkboxboolean | nullableOptional

Boolean field

jsonobject | nullableOptional

JSON field with arbitrary data

assigneestring | nullableOptional

Assigned user ID

textstring | nullableOptional

Text field

integernumber | nullableOptional

Integer field

singleSelectstring | nullableOptional

Select field option

Responses
200

200

application/json;charset=UTF-8
patch
/tables/{tableId}/records/{id}
PATCH /tables/{tableId}/records/{id} HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 24

{
  "json": {
    "key": "value"
  }
}
{
  "createdAt": "2025-09-01T16:40:04.854699+02:00",
  "json": {
    "key": "value"
  },
  "id": "60fc912a-77e0-4395-88ae-fef05d65ebb3",
  "version": 1,
  "updatedAt": "2025-09-01T16:40:04.873636+02:00"
}
Attachments

Last updated

Was this helpful?