Skip to main content
GET
/
api
/
v1
/
table
/
collections
/
{id}
/
documents
List collection documents
curl --request GET \
  --url https://flowra.dev/api/v1/table/collections/{id}/documents \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Path Parameters

​
id
string
required

Collection ID

Example:

"507f1f77bcf86cd799439011"

Query Parameters

​
q
string

Search keyword for filtering results

Example:

"john doe"

​
page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

​
offset
number

Number of items to skip (for offset-based pagination)

Required range: x >= 0
Example:

0

​
sortBy
string

Field name to sort by

Example:

"createdAt"

​
sortOrder
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC
Example:

"DESC"

​
fields
string

Comma-separated list of fields to include in response

Example:

"id,name,email"

​
selectedToolSlugs
string

Comma-separated selected tool slugs for sort-order (e.g. put toolkits with these tools first)

Example:

"tool_a,tool_b"

​
sort
string

Sort configuration in format: field:asc or field:desc or field1:asc,field2:desc. Overrides sortBy and sortOrder.

Example:

"createdAt:desc"

​
search
string

Search query to filter documents. Overrides q parameter.

Example:

"search term"

Response

200 - application/json

Documents retrieved successfully