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

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
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
POST /tables/{tableId}/records HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 52

"{\n  \"json\" : {\n    \"key\" : \"value\"\n  }\n}"
201

201

{
  "createdAt" : "2025-08-29T11:31:07.264446+02:00",
  "json" : {
    "key" : "value"
  },
  "id" : "55e25c54-9c07-4d5a-864f-4ca815a94d4e",
  "version" : 1,
  "updatedAt" : "2025-08-29T11:31:07.264446+02:00"
}

Get a record by ID

get

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
Responses
200

200

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

200

{
  "createdAt" : "2025-08-29T11:31:08.399514+02:00",
  "json" : {
    "key" : "value"
  },
  "id" : "075652fe-4d64-43ba-9951-b98a3ddd03d2",
  "version" : 1,
  "updatedAt" : "2025-08-29T11:31:08.399514+02:00"
}

Delete multiple records in batch

post

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
Bodyone of[]

Array of record IDs to delete

itemsone ofOptional
objectOptional
or
booleanOptional
or
stringOptional
or
numberOptional
Responses
204

204

No content

post
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: 46

"[ \"4eb09d9e-94ef-48e0-840d-817c960e9355\" ]"
204

204

No content

Search records in a table

post

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
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
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: 477

"{\n  \"filters\" : {\n    \"filters\" : [ {\n      \"fieldId\" : \"c45ffa7d-8eb0-4565-ac33-5ae567276718\",\n      \"operator\" : \"CONTAINS\",\n      \"value\" : \"value\",\n      \"type\" : \"JSON\"\n    } ],\n    \"groups\" : [ ],\n    \"conjunction\" : \"OR\"\n  },\n  \"pageSize\" : 5,\n  \"pageNumber\" : 1,\n  \"view\" : null,\n  \"search\" : null,\n  \"orderBy\" : [ {\n    \"fieldId\" : \"c45ffa7d-8eb0-4565-ac33-5ae567276718\",\n    \"direction\" : \"ASC\"\n  } ]\n}"
200

200

{
  "content" : [ ],
  "pageable" : {
    "pageNumber" : 1,
    "pageSize" : 5,
    "sort" : {
      "empty" : false,
      "sorted" : true,
      "unsorted" : false
    },
    "offset" : 5,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 1,
  "totalPages" : 1,
  "first" : false,
  "size" : 5,
  "number" : 1,
  "sort" : {
    "empty" : false,
    "sorted" : true,
    "unsorted" : false
  },
  "numberOfElements" : 0,
  "empty" : true
}

Delete a record by ID

delete

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
Responses
204

204

No content

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

204

No content

Update an existing record by ID

patch

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.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY0NTk4NjQsICJleHAiOjE3NTY0NjM0NjQsICJjdXN0b206dGVhbUlkIjoiNDgxMDYxODMtYTlmZS00YzQ3LWFjZjgtYzAzMTA4ZGEwYTM4In0.
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
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: 52

"{\n  \"json\" : {\n    \"key\" : \"value\"\n  }\n}"
200

200

{
  "createdAt" : "2025-08-29T11:31:09.405679+02:00",
  "json" : {
    "key" : "value"
  },
  "id" : "e30f91bb-83cb-4ab6-9a3f-f4cd73222eb5",
  "version" : 1,
  "updatedAt" : "2025-08-29T11:31:09.418878+02:00"
}
Attachments

Last updated

Was this helpful?