Browse table data (paginated)

GET

/api/v1/{bucket}/tables/{table}

• Production
• Development

Returns paginated rows from the specified table for the given bucket. Requires authentication.

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Path Parameters

bucket

required

string

/^[a-zA-Z0-9][a-zA-Z0-9\-]*$/

Flock bucket ID. The caller must have access to this bucket.

Example

example

table

required

string

Allowed values: person organisation member payment message membership_type ticket_type booking ticket attendee activity bank_account badge connection evidence pledge grant group group_member

Table name to browse.

Query Parameters

limit

integer

default: 100 <= 1000

Maximum rows to return (max 1000).

offset

integer

0

Number of rows to skip.

Responses

200

Paginated table rows

object

data

required

object

columns

required

Array<string>

rows

required

Array<Array>

meta

required

object

table

string

bucket

string

total

integer

limit

integer

offset

integer

401

Authentication required

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

403

Access denied to bucket

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "forbidden",
    "message": "Access denied to bucket 'example'"
  }
}

404

Resource not found

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "not_found",
    "message": "Unknown table: foo"
  }
}