Custom Tables: Content

List rows in a custom table (by table name)

Returns a paginated list of assembled rows for the table resolved from the path tableName.

get/v1/custom-table-data/{tableName}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/custom-table-data/{tableName}
  • Auth: API key in header x-api-key

Path parameters

tableNamestring required

Logical custom table name in kebab-case for this company. Must match an existing custom table (GET /custom-table-data/{tableName}); otherwise 404.

Query parameters

limitnumber

Maximum rows to return (default: 100, max: 1000). Invalid values can yield 400.

skipnumber

Number of rows to skip before returning results (default: 0). Parsed with limit via parseListQuery.

Response

data: assembled rows (each item maps field names to values). meta: count (total matching rows), skip, and limit as applied.

Example response

{
  "data": [
    {
      "rowId": {
        "$oid": "507f1f77bcf86cd799439011"
      }
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.