Datagrids

get

Retrieves multiple datagrids.

Query parameters
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
searchstring · min: 1Optional

Search term to filter datagrids by name or description.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all datagrids for the workspace.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
contentUpdatedAtstring · date-timeRequired

When the content of the datagrid was last updated.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the datagrid.

namestring · min: 3 · max: 50Required

The display name of the datagrid.

workspaceIdstring · uuidRequired

The workspace ID that owns the datagrid.

get
/api/v1/datagrids
post

Creates a new datagrid.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the datagrid.

namestring · min: 3 · max: 50Required

The display name of the datagrid.

workspaceIdstring · uuidRequired

The workspace ID that owns the datagrid.

Responses
200

The datagrid was created with default columns and example data.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
contentUpdatedAtstring · date-timeRequired

When the content of the datagrid was last updated.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the datagrid.

namestring · min: 3 · max: 50Required

The display name of the datagrid.

workspaceIdstring · uuidRequired

The workspace ID that owns the datagrid.

post
/api/v1/datagrids
get

Retrieves a datagrid.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves a datagrid.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
contentUpdatedAtstring · date-timeRequired

When the content of the datagrid was last updated.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the datagrid.

namestring · min: 3 · max: 50Required

The display name of the datagrid.

workspaceIdstring · uuidRequired

The workspace ID that owns the datagrid.

get
/api/v1/datagrids/{id}
delete

Removes a datagrid.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The datagrid was removed along with all associated columns, rows, and values.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/datagrids/{id}
patch

Updates a datagrid.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the datagrid.

namestring · min: 3 · max: 50Optional

The display name of the datagrid.

Responses
200

The datagrid was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
contentUpdatedAtstring · date-timeRequired

When the content of the datagrid was last updated.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the datagrid.

namestring · min: 3 · max: 50Required

The display name of the datagrid.

workspaceIdstring · uuidRequired

The workspace ID that owns the datagrid.

patch
/api/v1/datagrids/{id}

Last updated