Skip to main content
GET
/
v2
/
databases
List Databases
curl --request GET \
  --url https://api.jelou.ai/v2/databases \
  --header 'Authorization: Basic <encoded-value>'
{
  "message": [
    "<string>"
  ],
  "statusMessage": "<string>",
  "status": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "driver": "<string>",
      "description": "<string>",
      "companyId": 123,
      "schema": {},
      "state": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
The schema structure is key to validating data before inserting or querying records from your flows and skills.

​
Description

The Datum API allows you to query the databases available in Jelou and access their structure and metadata.
It is useful for listing schemas, validating fields, and preparing read or write operations from your flows.

​
Get databases

​
Endpoint

GET https://api.jelou.ai/v2/databases

​
Query parameters

​
shouldPaginate
string
Defines whether the results should be returned in paginated form.

​
Responses

  • 200 – OK Successful request.
  • 401 – Unauthorized Invalid or missing credentials.
  • 500 – Internal Server Error Internal server error.

​
\

Response example
{
  "message": ["Databases retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 123456789,
      "name": "JELOU TEST",
      "slug": "jeloutest",
      "driver": "elastic",
      "description": "JELOU TEST",
      "companyId": 135,
      "schema": {
        "type": "object",
        "properties": {
          "total": { "type": "string", "database": "text" },
          "name": { "type": "string", "database": "text" }
        },
        "required": ["total", "name"]
      }
    }
  ]
}

​
Database structure

Each database in Datum is composed of the following attributes:
PropertyTypeDescription
idstringUnique database identifier.
namestringDatabase name.
descriptionstringFunctional description of the database.
schemaobjectSchema that defines the fields and data types.
statebooleanDatabase state. true = active, false = deleted.
createdAtdateCreation date.
updatedAtdateDate of last update.
columnsarrayColumns visible in Datum, with name, description, and order.
metadataarrayAdditional metadata associated with the database.

​
Schema structure

Defines the shape and validations of stored data.
PropertyTypeDescription
typestringSchema type (usually object).
requiredarrayRequired fields when inserting a record.
propertiesobjectEach property represents a field and its data type.

​
Get information about a specific database

​
Endpoint

GET https://api.jelou.ai/v2/databases/DATABASE_ID

​
Path parameters

​
DATABASE_ID
string
required
Unique database identifier.

​
Responses

  • 200 – OK Database found.
  • 401 – Unauthorized Unauthorized.
  • 404 – Not Found Database not found.
  • 500 – Internal Server Error Internal server error.

​
Response example

{
  "message": ["Database retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "id": 123456789,
    "name": "JELOU TEST",
    "slug": "jeloutest",
    "schema": {
      "type": "object",
      "properties": {
        "total": { "type": "string", "database": "text" },
        "name": { "type": "string", "database": "text" }
      },
      "required": ["total", "name"]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Query Parameters

​
shouldPaginate
string

Response

Databases retrieved

​
message
string[]
​
statusMessage
string
​
status
integer
​
data
object[]