> ## Documentation Index
> Fetch the complete documentation index at: https://doc.eazemyapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Api endpoints

EazeMyAPI automatically generates REST API endpoints for every table created in your project.
These endpoints allow your applications to perform standard **CRUD operations**:

* Create data
* Read data
* Update data
* Delete data

No backend server code is required.

***

# Endpoint Structure

All EazeMyAPI endpoints follow a consistent structure.

```
https://api.eazemyapi.com/{project-name}/{table}/{version}/{action}
```

Example:

```
https://api.eazemyapi.com/my-project/users/v1/list
```

Components:

| Part                | Description                                  |
| ------------------- | -------------------------------------------- |
| `api.eazemyapi.com` | API server                                   |
| `{project-name}`    | Your project identifier                      |
| `{table}`           | The table name                               |
| `{version}`         | API version (e.g. `v1`, `v2`)                |
| `{action}`          | API action (e.g. `list`, `create`, `delete`) |

***

# Common Endpoint Types

When you create a table, EazeMyAPI automatically generates endpoints for common operations.

***

## List

Retrieve all records from a table.

```
GET https://api.eazemyapi.com/{project-name}/{table}/{version}/list
```

Example request:

```bash theme={null}
curl -X GET https://api.eazemyapi.com/my-project/users/v1/list \
  -H "X-API-SIGNATURE: your-secret-key"
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Data found.",
  "data": [
    {
      "id": 1,
      "name": "Dara Singh",
      "email": "dara@example.com"
    }
  ]
}
```

***

## Show

Retrieve a single record by ID.

```
GET https://api.eazemyapi.com/{project-name}/{table}/{version}/show/:id
```

Example request:

```bash theme={null}
curl -X GET https://api.eazemyapi.com/my-project/users/v1/show/1 \
  -H "X-API-SIGNATURE: your-secret-key"
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Data found.",
  "data": {
    "id": 1,
    "name": "Dara Singh",
    "email": "dara@example.com"
  }
}
```

***

## Create

Create a new record in a table.

```
POST https://api.eazemyapi.com/{project-name}/{table}/{version}/create
```

Example request:

```bash theme={null}
curl -X POST https://api.eazemyapi.com/my-project/users/v1/create \
  -H "Content-Type: application/json" \
  -H "X-API-SIGNATURE: your-secret-key" \
  -d '{
    "name": "Dara Singh",
    "email": "dara@example.com"
  }'
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Record created successfully.",
  "data": {
    "id": 1,
    "name": "Dara Singh",
    "email": "dara@example.com"
  }
}
```

***

## Update

Update an existing record by ID.

```
POST https://api.eazemyapi.com/{project-name}/{table}/{version}/update/:id
```

Example request:

```bash theme={null}
curl -X POST https://api.eazemyapi.com/my-project/users/v1/update/1 \
  -H "Content-Type: application/json" \
  -H "X-API-SIGNATURE: your-secret-key" \
  -d '{
    "name": "Dara Singh"
  }'
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Record updated successfully.",
  "data": {
    "id": 1,
    "name": "Dara Singh",
    "email": "dara@example.com"
  }
}
```

***

## Delete

Delete a record by ID.

```
DELETE https://api.eazemyapi.com/{project-name}/{table}/{version}/delete/:id
```

Example request:

```bash theme={null}
curl -X DELETE https://api.eazemyapi.com/my-project/users/v1/delete/1 \
  -H "X-API-SIGNATURE: your-secret-key"
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Record deleted successfully."
}
```

***

# Custom Endpoints

EazeMyAPI also supports **raw custom query endpoints** for more advanced use cases. Unlike CRUD endpoints, custom queries are not tied to a specific table — so there is no `{table}` segment in the URL.

```
https://api.eazemyapi.com/{project-name}/{version}/{custom-endpoint}
```

Example request:

```bash theme={null}
curl https://api.eazemyapi.com/my-project/v1/posts-by-category \
  -H "X-API-SIGNATURE: your-secret-key"
```

Example response:

```json theme={null}
{
  "success": true,
  "message": "Data found.",
  "data": [
    {
      "category_id": "c40a4731-a541-4d2b-af77-326af7142aab",
      "category_name": "Foods",
      "post_id": "2529c967-33a3-4f7b-aabd-84e90f861e14",
      "description": "Best restaurant in the world"
    }
  ]
}
```

***

# Best Practices

When using EazeMyAPI endpoints:

* Always include the **`X-API-SIGNATURE` header**
* Validate request parameters before sending
* Handle error responses properly
* Use HTTPS for all API requests

***

# Related Documentation

Learn how authentication works:

[Authentication](/docs/authentication)

Understand response structure:

[API Response Format](/docs/response-format)