Budibase-PHP

Budibase API wrapper for PHP

About

This is a simple PHP wrapper for the official Budibase API.

Dependencies

Budibase-PHP requires guzzle/guzzle:

composer require guzzlehttp/guzzle

Built using

• Budibase API Reference
• GitHub Copilot

Status

Budibase-PHP is in developement state and probably not ready for production environments.

Test the wrapper & let me know if something is wrong.

Documentation

Applications

create → applications_create

string $app_id,
string $name,
[string $url]

update → applications_update

string $app_id,
string $name,
[string $url]

delete → applications_delete

string $app_id

retrieve → applications_retrieve

string $app_id

search → applications_search

string $name

Queries

execute → queries_execute

string $app_id,
string $query_id,
[
  object $parameters,
  object $pagination
]

search → queries_search

string $app_id,
string $name

Rows

create → rows_create

string $app_id,
string $table_id,
[array $body]

update → rows_update

string $app_id,
string $table_id,
string $row_id,
[array $body]

delete → rows_delete

string $app_id,
string $table_id,
string $row_id

retrieve → rows_retrieve

string $app_id,
string $table_id,
string $row_id

search → rows_search

string $app_id,
string $table_id,
object $query,
[
  bool $paginate,
  string|int $bookmark,
  int $limit,
  object $sort
]

Tables

create → tables_create

string $app_id,
string $name,
[
  string $primaryDisplay,
  object $schema
]

update → tables_update

string $app_id,
string $table_id,
string $name,
object $schema,
[string $primaryDisplay]

delete → tables_delete

string $app_id,
string $table_id

retrieve → tables_retrieve

string $app_id,
string $table_id

search → tables_search

string $app_id,
string $name

Users

create → users_create

string $email,
object $roles,
[
  string $password,
  string $status,
  string $firstName,
  string $lastName,
  bool $forceResetPassword,
  object $builder,
  object $admin
]

update → users_update

string $user_id,
string $email,
object $roles,
[
  string $password,
  string $status,
  string $firstName,
  string $lastName,
  bool $forceResetPassword,
  object $builder,
  object $admin
]

delete → users_delete

string $user_id

retrieve → users_retrieve

string $user_id

search → users_search

string $name