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
Identifier of the table to create the record in
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.Date field
Identifier field in UUID format
Number field
DateTime field
Boolean field
JSON field with arbitrary data
Assigned user ID
Text field
Integer field
Select field option
201
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
Get a record by ID
Identifier of the table containing the record
Identifier of the record to retrieve
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.200
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
Delete multiple records in batch
Identifier of the table containing the records
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.Array of record IDs to delete
204
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
No content
Search records in a table
Identifier of the table to search records in
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.Optional view ID to filter records
Page number (0-based)
Number of records per page
200
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
Delete a record by ID
Identifier of the table containing the record
Identifier of the record to delete
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.204
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
No content
Update an existing record by ID
Identifier of the table containing the record
Identifier of the record to update
Content type of the response
application/json;charset=UTF-8Bearer token for authentication
Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.Date field
Identifier field in UUID format
Number field
DateTime field
Boolean field
JSON field with arbitrary data
Assigned user ID
Text field
Integer field
Select field option
200
Bad Request – invalid request parameters
Unauthorized – JWT token missing or invalid
Forbidden – insufficient permissions
Not Found – resource does not exist
Internal Server Error – unexpected server error
Last updated
Was this helpful?