Endpoints

Fireapis provides various pre-created endpoints during the table creation process, which are sufficient for most common use cases.

These Endpoint provide request URLs and information on how to use them. Most business use cases can be solved with these APIs. However, if you need more complex business logic, then you can refer to the logics section.

Endpoint Section

The image above shows the different endpoints, and below you will find more details about each one.

Here's different endpoint details

{{table}} represent your actual table name.

{{environmentName}} represent your actual environment name

POST - Create a new record in {{table}}

This is a POST type endpoint, useful for adding a record to your table using the endpoint. This endpoints can be used in the no-code UI builder or any frontend client application.

In this case, the PK(Primary Key) column will be disabled by default, as it is automatically created by Fireapis as a unique value.

Disabled Primary key Column

You can find the implementation of this endpoint by using the generated URL. Here are the configuration details:

Header: Common header for every endpoint request.

URL: https://{{environmentName}}.fireapis.com/{{table}}

Data or Body: JSON as provided in the endpoint section.

For more details, Refer to the images below.

[POST] Create a New Record in Table.

GET - Get a record in {{table}} by ID

This is a GET type endpoint, useful for retrieving a record using its primary key (ID by default in Fireapis).

Configuration details:

Header: Common header for every endpoint request.

URL: https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body: No input data is required for a GET request.

__id__ represent the primary key value of a record. For example, to fetch the record with ID of 2 from your table.

For more details, Refer to the images below.

Get a Record from {{table}} by id

PUT - Update record in {{table}} by id

This endpoint is PUT type endpoint which will be useful for updating a record using their primary key which is id by default in fireapis.

Here the list of configurations

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body - JSON which is given in this endpoint section

__id__ represent the primary key value of an record, for eg: you want to fetch id of 2 from your table.

For all above details, Refer below images:

Update a Record in {{table}} by ID

DELETE - Delete a record in {{table}} by ID

This is a DELETE type endpoint, useful for deleting a record using its primary key (ID by default in Fireapis).

Configurations details:

Header: Common header for every endpoint request.

URL: https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body: No input data is required for a DELETE request.

__id__ represent the primary key value of a record. For example, you want to fetch id of 2 from your table.

Warning: Deleting a record will permanently removes it, so be cautious when performing this action.

For more details, refer to the images below.

Delete a record in {{table}} by ID

GET - Get all records in {{table}}

This is a GET type endpoint, useful for retrieving all records from particular table, with paginated enabled by default.

Configuration details:

Header: Common header for every endpoint request.

URL: https://{{environmentName}}.fireapis.com/{{table}}/all?page=1&take=10

Data or Body: No input data is required for GET request.

Query Params: ?page=1&take=10 in URL represent query parameters. 1. page: The page number for the request data 2. take: The Number of records to be listed on each page For example, ?page=2&take20 means getting the second page with 20 records per page.

This endpoint always includes pagination by default to optimize performance.

For more details, Refer to the images below.

Get all record in {{table}}

We have covered all the endpoints in detail and their usage.