Collections

Returns all collections that the user has access to

Get a list of Collections.

GET/api/1.0/collections

Query parameters

Response

200

list of collections

Body

application/json

dataarray of collections (all of)

metametadata (object)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "custom_title": "text",
      "create_screen_id": "text",
      "read_screen_id": "text",
      "update_screen_id": "text",
      "signal_create": false,
      "signal_update": false,
      "signal_delete": false,
      "created_at": "2024-05-11T15:54:04.858Z",
      "updated_at": "2024-05-11T15:54:04.858Z",
      "created_by_id": "text",
      "updated_by_id": "text",
      "columns": []
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new collections

Create a new Collection.

POST/api/1.0/collections

Body

application/json

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

201

success

Body

application/json

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": false,
  "signal_update": false,
  "signal_delete": false,
  "created_at": "2024-05-11T15:54:04.858Z",
  "updated_at": "2024-05-11T15:54:04.858Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": []
}

Get single collections by ID

Get a single Collection.

GET/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to return

Response

200

Successfully found the collections

Body

application/json

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": false,
  "signal_update": false,
  "signal_delete": false,
  "created_at": "2024-05-11T15:54:04.858Z",
  "updated_at": "2024-05-11T15:54:04.858Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": []
}

Update a collection

Update a Collection.

PUT/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to update

Body

application/json

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a collection

Delete a Collection.

DELETE/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to return

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Trigger export collections job

Export the specified collection.

POST/api/1.0/collections/{collection_id}/export

Path parameters

collection_id*string

ID of the collection to export

Response

202

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/export', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Import a new collection

Import the specified collection.

POST/api/1.0/collections/import

Body

multipart/form-data

file*file (file)

file to upload

Response

200201

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/import', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Deletes all records in a collection

Truncate a Collection.

DELETE/api/1.0/collections/{collection_id}/truncate

Path parameters

collection_id*string

ID of collection to truncate

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/truncate', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns all records

Get the list of records of a collection.

GET/api/1.0/collections/{collection_id}/records

Path parameters

collection_id*string

ID of collection to get records for

Query parameters

Response

200

list of records of a collection

Body

application/json

dataarray of records (all of)

metametadata (object)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "collection_id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new record in a collection

Create a new record in a Collection.

POST/api/1.0/collections/{collection_id}/records

Path parameters

collection_id*string

ID of the collection

Body

application/json

dataobject

Response

201

success

Body

application/json

dataobject

idinteger

collection_idstring (id)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "collection_id": "text"
}

Get single record of a collection

Get a single record of a Collection.

GET/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of the collection

record_id*string

ID of the record to return

Response

200

Successfully found the record

Body

application/json

dataobject

idinteger

collection_idstring (id)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records/{record_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "collection_id": "text"
}

Update a record

Update a record in a Collection.

PUT/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of the record

Body

application/json

dataobject

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records/{record_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a collection record

Delete a record of a Collection.

DELETE/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of record in collection

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records/{record_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Partial update of a record

Implements a partial update of a record in a Collection.

PATCH/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of the record

Body

application/json

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

200

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/collections/{collection_id}/records/{record_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();