Custom Data

Custom data table rows

Get custom data row by ID

get

Retrieve a single custom data table row by its identifier, within the authenticated organization.

Organization-scoped tokens have full access. For user-scoped tokens the row is returned only if the user's role has view access to the table and the row.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

tableNamestringRequired

Name of the custom data table the row belongs to.

idinteger · int32Required

Identifier of the row within the table.

Responses

200

The custom data table row.

application/json

A single row of a custom data table.

idinteger · int32Required

Unique identifier of the row within its table.

Example: 42

orgIdinteger · int32Required

Identifier of the organization the row belongs to.

Example: 1

valuesone of[]Required

Column values of the row, one entry per table column, in the same order as the columns are defined in the table.

Example: {"type":"text","columnName":"name","value":"Order 1"}

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

canEditbooleanRequired

Whether the authenticated user is allowed to edit this row.

canDeletebooleanRequired

Whether the authenticated user is allowed to delete this row.

modifiedAtinteger · int64Required

Timestamp (Unix epoch milliseconds) of the last row modification.

Example: 1720000000000

400

Bad request

application/json

403

Forbidden. The authenticated user has no access to the table or the row.

application/json

404

Table or row not found.

application/json

429

Too many requests

500

Internal server error

application/json

get/api/v1/organization/custom-data/row

HTTPcURLJavaScriptPython

GET /api/v1/organization/custom-data/row?tableName=text&id=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 42,
  "orgId": 1,
  "values": [
    {
      "type": "double",
      "columnName": "temperature",
      "value": 30.1,
      "decimalsFormat": "NO_FRACTION",
      "unit": "Celsius"
    }
  ],
  "canEdit": true,
  "canDelete": true,
  "modifiedAt": 1720000000000
}

Delete custom data row by ID

delete

Delete a single custom data table row by its identifier, within the authenticated organization.

Organization-scoped tokens have full access. For user-scoped tokens the row is deleted only if the user's role has delete access to the table and edit access to the row.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

tableNamestringRequired

Name of the custom data table the row belongs to.

idinteger · int32Required

Identifier of the row within the table.

Responses

204

The row was deleted.

No content

400

Bad request

application/json

403

Forbidden. The authenticated user has no access to the table or the row.

application/json

404

Table or row not found.

application/json

429

Too many requests

500

Internal server error

application/json

delete/api/v1/organization/custom-data/row

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/custom-data/row?tableName=text&id=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get custom data table rows

post

Retrieve a page of custom data table rows within the authenticated organization, with optional sorting, filtering and display-column search.

Organization-scoped tokens have full access. For user-scoped tokens rows are returned only if the user's role has view access to the table, and the result is limited to the rows the user is allowed to see.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

application/json

Request payload for retrieving a page of custom data table rows.

tableNamestringRequired

Name of the custom data table to read rows from.

Example: orders

pageinteger · int32Optional

Zero-based index of the page to return.

Example: 0

sizeinteger · int32 · max: 100Optional

Maximum number of rows to return per page.

Example: 20

sortingstring · enumRequired

Sorting mode applied to the returned rows.

Possible values:

sortColumnstring · nullableOptional

Name of the column to sort by. Only used together with the CUSTOM_ASCENDING / CUSTOM_DESCENDING sorting modes.

Example: name

filterone of · nullableOptional

A filter applied to the table rows. The concrete schema depends on the type discriminator property.

or

or

or

searchQuerystring · nullableOptional

Optional case-insensitive query matched against the value of the table's display column.

Example: Order A

includeSubOrgsbooleanOptional

Whether to include rows owned by sub-organizations. Only effective for tables that share rows with sub-organizations and when reading from the root organization.

Example: false

Responses

200

A page of custom data table rows.

application/json

A page of custom data table rows together with the total row count.

totalRowsinteger · int32Required

Total number of rows matching the request (before pagination is applied).

Example: 3

400

Bad request. The request body is missing, malformed or fails validation.

application/json

403

Forbidden. The authenticated user has no access to the table.

application/json

404

Table not found.

application/json

429

Too many requests

500

Internal server error

application/json

post/api/v1/organization/custom-data/rows

HTTPcURLJavaScriptPython

POST /api/v1/organization/custom-data/rows HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "tableName": "orders",
  "page": 0,
  "size": 20,
  "sorting": "ASCENDING",
  "sortColumn": "name",
  "filter": {
    "type": "and",
    "filters": [
      {
        "type": "and",
        "filters": [
          "[Circular Reference]"
        ]
      }
    ]
  },
  "searchQuery": "Order A",
  "includeSubOrgs": false
}

{
  "rows": [
    {
      "id": 42,
      "orgId": 1,
      "values": [
        {
          "type": "double",
          "columnName": "temperature",
          "value": 30.1,
          "decimalsFormat": "NO_FRACTION",
          "unit": "Celsius"
        }
      ],
      "canEdit": true,
      "canDelete": true,
      "modifiedAt": 1720000000000
    }
  ],
  "totalRows": 3
}

Create a custom data table row

post

Create a new row in a custom data table within the authenticated organization.

The values array contains the column values to set for the new row. Columns that are not provided fall back to their default value (or stay empty when they have none); required columns without a value cause the request to be rejected. Read-only columns such as created_at, modified_at and created_by are populated automatically.

Organization-scoped tokens have full access. For user-scoped tokens the row is created only if the user's role has create access to the table, and the created_by column, when present, is attributed to the authenticated user.

Organization-scoped tokens have no associated user, so the created_by column is not populated automatically for them. If the table has a required created_by column, an organization-scoped token must supply a value for it in the values array, otherwise the request is rejected.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

application/json

Request payload for creating a custom data table row.

tableNamestringRequired

Name of the custom data table to create the row in.

Example: orders

valuesone of[]Optional

Column values to set for the new row. Each entry targets a column by its columnName. Order is not significant.

Example: {"type":"text","columnName":"name","value":"Order 1"}

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

201

The created custom data table row.

application/json

A single row of a custom data table.

idinteger · int32Required

Unique identifier of the row within its table.

Example: 42

orgIdinteger · int32Required

Identifier of the organization the row belongs to.

Example: 1

valuesone of[]Required

Column values of the row, one entry per table column, in the same order as the columns are defined in the table.

Example: {"type":"text","columnName":"name","value":"Order 1"}

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

canEditbooleanRequired

Whether the authenticated user is allowed to edit this row.

canDeletebooleanRequired

Whether the authenticated user is allowed to delete this row.

modifiedAtinteger · int64Required

Timestamp (Unix epoch milliseconds) of the last row modification.

Example: 1720000000000

400

Bad request. The request body is missing, malformed or fails validation.

application/json

403

Forbidden. The authenticated user has no access to create rows in the table.

application/json

404

Table not found.

application/json

429

Too many requests

500

Internal server error

application/json

post/api/v1/organization/custom-data/row/create

HTTPcURLJavaScriptPython

POST /api/v1/organization/custom-data/row/create HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "tableName": "orders",
  "values": [
    {
      "type": "double",
      "columnName": "temperature",
      "value": 30.1,
      "decimalsFormat": "NO_FRACTION",
      "unit": "Celsius"
    }
  ]
}

{
  "id": 42,
  "orgId": 1,
  "values": [
    {
      "type": "double",
      "columnName": "temperature",
      "value": 30.1,
      "decimalsFormat": "NO_FRACTION",
      "unit": "Celsius"
    }
  ],
  "canEdit": true,
  "canDelete": true,
  "modifiedAt": 1720000000000
}