# Overview

> Complete API reference for GATE API with 45 endpoints across 20 categories.

**Version:** v1  
**Base URL:** `https://gate.zequenze.com/api/v1`

Zequenze GATE platform API documentation

---

## Authentication

All API endpoints require authentication using a Bearer token in the request header:

```http
Authorization: Bearer <your-api-token>
```

You can obtain your API token from the portal administration panel.

---

## Available Endpoints

| Category | Endpoints | Methods |
|----------|:---------:|---------|
| [Aaa Accounting](https://docs.zequenze.com/books/gate-api-reference/page/aaa-accounting-k7Z) | 2 | `GET` |
| [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) | 6 | `DELETE` `GET` `PATCH` `POST` `PUT` |
| [Device App Access Devices](https://docs.zequenze.com/books/gate-api-reference/page/device-app-access-devices-HDH) | 1 | `GET` |
| [Device App Access Points](https://docs.zequenze.com/books/gate-api-reference/page/device-app-access-points-5ss) | 1 | `GET` |
| [Device App Connection Log](https://docs.zequenze.com/books/gate-api-reference/page/device-app-connection-log-7uS) | 1 | `POST` |
| [Device App Connection Summary](https://docs.zequenze.com/books/gate-api-reference/page/device-app-connection-summary-i4D) | 1 | `GET` |
| [Device App Locations](https://docs.zequenze.com/books/gate-api-reference/page/device-app-locations-x39) | 1 | `GET` |
| [Device App Register](https://docs.zequenze.com/books/gate-api-reference/page/device-app-register-MLh) | 1 | `POST` |
| [Device App Test Report](https://docs.zequenze.com/books/gate-api-reference/page/device-app-test-report-0Bv) | 1 | `POST` |
| [Device App User Authenticate](https://docs.zequenze.com/books/gate-api-reference/page/device-app-user-authenticate-dUz) | 1 | `POST` |
| [Device App User Update](https://docs.zequenze.com/books/gate-api-reference/page/device-app-user-update-l1W) | 1 | `POST` |
| [Hostspot Access Points](https://docs.zequenze.com/books/gate-api-reference/page/hostspot-access-points-h87) | 1 | `GET` |
| [Hostspot Locations](https://docs.zequenze.com/books/gate-api-reference/page/hostspot-locations-4pw) | 1 | `GET` |
| [Me](https://docs.zequenze.com/books/gate-api-reference/page/me-Vp5) | 1 | `GET` |
| [Organization](https://docs.zequenze.com/books/gate-api-reference/page/organization-OMu) | 1 | `GET` |
| [Portal Login](https://docs.zequenze.com/books/gate-api-reference/page/portal-login-KoR) | 1 | `POST` |
| [Txlog Portal](https://docs.zequenze.com/books/gate-api-reference/page/txlog-portal-8Yf) | 1 | `GET` |
| [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) | 10 | `DELETE` `GET` `PATCH` `POST` `PUT` |
| [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) | 6 | `DELETE` `GET` `PATCH` `POST` `PUT` |
| [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) | 6 | `DELETE` `GET` `PATCH` `POST` `PUT` |

---

## All Endpoints

| Method | Path | Documentation |
|:------:|------|---------------|
| `GET` | <a href="https://gate.zequenze.com/api#/aaa_accounting/aaa_accounting_list" target="_blank">`/aaa_accounting/`</a> | [Aaa Accounting](https://docs.zequenze.com/books/gate-api-reference/page/aaa-accounting-k7Z) |
| `GET` | <a href="https://gate.zequenze.com/api#/aaa_accounting/aaa_accounting_read" target="_blank">`/aaa_accounting/{radacctid}/`</a> | [Aaa Accounting](https://docs.zequenze.com/books/gate-api-reference/page/aaa-accounting-k7Z) |
| `GET` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_list" target="_blank">`/aaa_profile/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `POST` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_create" target="_blank">`/aaa_profile/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `GET` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_read" target="_blank">`/aaa_profile/{id}/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `PUT` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_update" target="_blank">`/aaa_profile/{id}/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `PATCH` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_partial_update" target="_blank">`/aaa_profile/{id}/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `DELETE` | <a href="https://gate.zequenze.com/api#/aaa_profile/aaa_profile_delete" target="_blank">`/aaa_profile/{id}/`</a> | [Aaa Profile](https://docs.zequenze.com/books/gate-api-reference/page/aaa-profile-M6Z) |
| `GET` | <a href="https://gate.zequenze.com/api#/device_app_access_devices/device_app_access_devices_list" target="_blank">`/device_app_access_devices/`</a> | [Device App Access Devices](https://docs.zequenze.com/books/gate-api-reference/page/device-app-access-devices-HDH) |
| `GET` | <a href="https://gate.zequenze.com/api#/device_app_access_points/device_app_access_points_list" target="_blank">`/device_app_access_points/`</a> | [Device App Access Points](https://docs.zequenze.com/books/gate-api-reference/page/device-app-access-points-5ss) |
| `POST` | <a href="https://gate.zequenze.com/api#/device_app_connection_log/device_app_connection_log_create" target="_blank">`/device_app_connection_log/`</a> | [Device App Connection Log](https://docs.zequenze.com/books/gate-api-reference/page/device-app-connection-log-7uS) |
| `GET` | <a href="https://gate.zequenze.com/api#/device_app_connection_summary/device_app_connection_summary_list" target="_blank">`/device_app_connection_summary/`</a> | [Device App Connection Summary](https://docs.zequenze.com/books/gate-api-reference/page/device-app-connection-summary-i4D) |
| `GET` | <a href="https://gate.zequenze.com/api#/device_app_locations/device_app_locations_list" target="_blank">`/device_app_locations/`</a> | [Device App Locations](https://docs.zequenze.com/books/gate-api-reference/page/device-app-locations-x39) |
| `POST` | <a href="https://gate.zequenze.com/api#/device_app_register/device_app_register_create" target="_blank">`/device_app_register/`</a> | [Device App Register](https://docs.zequenze.com/books/gate-api-reference/page/device-app-register-MLh) |
| `POST` | <a href="https://gate.zequenze.com/api#/device_app_test_report/device_app_test_report_create" target="_blank">`/device_app_test_report/`</a> | [Device App Test Report](https://docs.zequenze.com/books/gate-api-reference/page/device-app-test-report-0Bv) |
| `POST` | <a href="https://gate.zequenze.com/api#/device_app_user_authenticate/device_app_user_authenticate_create" target="_blank">`/device_app_user_authenticate/`</a> | [Device App User Authenticate](https://docs.zequenze.com/books/gate-api-reference/page/device-app-user-authenticate-dUz) |
| `POST` | <a href="https://gate.zequenze.com/api#/device_app_user_update/device_app_user_update_create" target="_blank">`/device_app_user_update/`</a> | [Device App User Update](https://docs.zequenze.com/books/gate-api-reference/page/device-app-user-update-l1W) |
| `GET` | <a href="https://gate.zequenze.com/api#/hostspot_access_points/hostspot_access_points_list" target="_blank">`/hostspot_access_points/`</a> | [Hostspot Access Points](https://docs.zequenze.com/books/gate-api-reference/page/hostspot-access-points-h87) |
| `GET` | <a href="https://gate.zequenze.com/api#/hostspot_locations/hostspot_locations_list" target="_blank">`/hostspot_locations/`</a> | [Hostspot Locations](https://docs.zequenze.com/books/gate-api-reference/page/hostspot-locations-4pw) |
| `GET` | <a href="https://gate.zequenze.com/api#/me/me_organization_list" target="_blank">`/me/organization/`</a> | [Me](https://docs.zequenze.com/books/gate-api-reference/page/me-Vp5) |
| `GET` | <a href="https://gate.zequenze.com/api#/organization/organization_list" target="_blank">`/organization/`</a> | [Organization](https://docs.zequenze.com/books/gate-api-reference/page/organization-OMu) |
| `POST` | <a href="https://gate.zequenze.com/api#/portal_login/portal_login_create" target="_blank">`/portal_login/`</a> | [Portal Login](https://docs.zequenze.com/books/gate-api-reference/page/portal-login-KoR) |
| `GET` | <a href="https://gate.zequenze.com/api#/txlog_portal/txlog_portal_list" target="_blank">`/txlog_portal/`</a> | [Txlog Portal](https://docs.zequenze.com/books/gate-api-reference/page/txlog-portal-8Yf) |
| `GET` | <a href="https://gate.zequenze.com/api#/user/user_list" target="_blank">`/user/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `POST` | <a href="https://gate.zequenze.com/api#/user/user_create" target="_blank">`/user/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `GET` | <a href="https://gate.zequenze.com/api#/user/user_username_read" target="_blank">`/user/username/{username}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `PUT` | <a href="https://gate.zequenze.com/api#/user/user_username_update" target="_blank">`/user/username/{username}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `PATCH` | <a href="https://gate.zequenze.com/api#/user/user_username_partial_update" target="_blank">`/user/username/{username}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `DELETE` | <a href="https://gate.zequenze.com/api#/user/user_username_delete" target="_blank">`/user/username/{username}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `GET` | <a href="https://gate.zequenze.com/api#/user/user_read" target="_blank">`/user/{id}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `PUT` | <a href="https://gate.zequenze.com/api#/user/user_update" target="_blank">`/user/{id}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `PATCH` | <a href="https://gate.zequenze.com/api#/user/user_partial_update" target="_blank">`/user/{id}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `DELETE` | <a href="https://gate.zequenze.com/api#/user/user_delete" target="_blank">`/user/{id}/`</a> | [User](https://docs.zequenze.com/books/gate-api-reference/page/user-j1q) |
| `GET` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_list" target="_blank">`/user_extra/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `POST` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_create" target="_blank">`/user_extra/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `GET` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_read" target="_blank">`/user_extra/{id}/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `PUT` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_update" target="_blank">`/user_extra/{id}/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `PATCH` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_partial_update" target="_blank">`/user_extra/{id}/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `DELETE` | <a href="https://gate.zequenze.com/api#/user_extra/user_extra_delete" target="_blank">`/user_extra/{id}/`</a> | [User Extra](https://docs.zequenze.com/books/gate-api-reference/page/user-extra-Bk0) |
| `GET` | <a href="https://gate.zequenze.com/api#/user_token/user_token_list" target="_blank">`/user_token/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |
| `POST` | <a href="https://gate.zequenze.com/api#/user_token/user_token_create" target="_blank">`/user_token/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |
| `GET` | <a href="https://gate.zequenze.com/api#/user_token/user_token_read" target="_blank">`/user_token/{id}/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |
| `PUT` | <a href="https://gate.zequenze.com/api#/user_token/user_token_update" target="_blank">`/user_token/{id}/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |
| `PATCH` | <a href="https://gate.zequenze.com/api#/user_token/user_token_partial_update" target="_blank">`/user_token/{id}/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |
| `DELETE` | <a href="https://gate.zequenze.com/api#/user_token/user_token_delete" target="_blank">`/user_token/{id}/`</a> | [User Token](https://docs.zequenze.com/books/gate-api-reference/page/user-token-7jF) |

---

## Quick Start

### 1. Authentication
Obtain your API token from the portal and include it in all requests.

### 2. Make a Request
```bash
curl -X GET "https://gate.zequenze.com/api/v1/endpoint/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

### 3. Handle the Response
All responses are in JSON format. List endpoints include pagination.

---

## Response Codes

| Code | Status | Description |
|:----:|--------|-------------|
| 200 | OK | Request successful |
| 201 | Created | Resource created successfully |
| 204 | No Content | Request successful (DELETE operations) |
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Missing or invalid authentication token |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Resource not found |
| 500 | Server Error | Internal server error |

---

## Pagination

List endpoints return paginated results:

```json
{
  "count": 150,
  "next": "https://api.example.com/endpoint/?offset=50",
  "previous": null,
  "results": [...]
}
```

Use `limit` and `offset` query parameters to navigate through results.