Links

Database APIs

This is a general example of Deskree REST APIs. You can download it as a postman collection from the API Docs page of your project.
base_url is equal to https://YOUR_PROJECT_ID.api.deskree.com/api/v1/
Note that the Users table is a special table and does not allow POST or DELETE requests since account creation/removal is handled by AUTH APIs. For more information, view our Users Table guide.
If you receive 412 error, it means that an index needs to be created for your query. Deskree handles this process automatically. For more information, visit the Indexes page.
get
base_url
/TABLE_NAME
Get list of all rows in TABLE_NAME
get
base_url
/TABLE_NAME/ROW_UID
Get row by UID from TABLE_NAME
post
base_url
/TABLE_NAME
Create a new row in TABLE_NAME
patch
base_url
/TABLE_NAME/ROW_UID
Update row by UID in TABLE_NAME
delete
base_url
/TABLE_NAME/ROW_UID
Delete row by UID in TABLE_NAME

Where object

Note that UID cannot be used in the attribute field. If you want to get an item by UID, you can use the Get by UID endpoint instead.
Field
Data Type
Description
attribute
string
Column name that you would like to query by
operator
< | > | == | != | <= | >= | array-contains | array-contains-any | in | not-in
An operator to perform the query
value
any
Value of the query

GET Response Structure

Parameters

Field
Data Type
Description
data
Array of objects
Array of data objects
meta
Object
Object containing metadata

Database Object Parameters

Field
Data Type
Description
uid
string
UID of a database item
attributes
Object
Object containing all database item values

Metadata Parameters

Field
Data Type
Description
total
number
Total number of items in the database
page
number
Current page number
limit
number
Current limit per page
includesCount
number
Number of additional requests for the includes operations

POST, PATCH, and DELETE Response Structure

Parameters

Field
Data Type
Description
data
Object
Object containing all database item values
meta
Object
Object containing metadata
info
Object
Object containing operation information

Metadata Parameters

Field
Data Type
Description
total
number
Total number of items in with the given UID Always equal to 1
page
number
Current page number Always equal to 1
limit
number
Current limit per page Always equal to 1
includesCount
number
Number of additional requests for the includes operations
Always equal to 0

Info Parameters

Field
Data Type
Description
action
string
Operation name
webhooksTriggered
number
Number of webhooks triggered by the operation

Helpful Resources

Copyright © 2023 Deskree Technologies Inc.