Find endpoints by method, path, function group or authentication mechanism.

Base path

/api/v1

Base path /api/v1 Public base URL https://jsonapis.net

Public base URL

Use this configured origin as the prefix for every API endpoint shown below.

https://jsonapis.net

X-API-Key

Create an API key in Settings, then send its secret in the X-API-Key request header.

Open API Keys Go to API Keys. Sign in first if the settings page asks for authentication.
Generate a key Give the key a name, select only the scopes required by your integration, and optionally set an expiration date.
Save the secret Copy the secret when it is issued. The service does not display the full value again.

curl "https://jsonapis.net/api/v1/resources" \
  -H "X-API-Key: <api-key>" \
  -H "Accept: application/json"

Open Parameters to see the position and required level of each parameter.

Find endpoints

endpoints

89 endpoints

GET /api/v1/analytics?range=7d

Operations

User-scoped request volume, reliability, latency and endpoint breakdown.

Auth usage:read

Parameters 1

range Query Optional

Optional query value; omit it to use the server default.

GET /api/v1/platform

Platform

Kiểm tra metadata và trạng thái dịch vụ.

Auth Public

POST /api/v1/auth/register

Authentication

Tạo tài khoản và phiên đăng nhập đầu tiên.

Auth Public

Parameters 1

body JSON body Required

Request payload documented by this operation.

POST /api/v1/auth/login

Authentication

Đăng nhập và nhận access token cùng refresh token.

Auth Public

Parameters 1

body JSON body Required

Request payload documented by this operation.

POST /api/v1/auth/refresh-token

Authentication

Đổi refresh token lấy cặp token mới.

Auth Public

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/auth/me

Authentication

Đọc thông tin principal hiện tại.

Auth JWT hoặc API key

POST /api/v1/resources

Resources

Tạo JSON resource.

Auth resource:write

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/resources

Resources

Liệt kê resource bằng cursor, filter và projection.

Auth resource:read

Parameters 8

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Number of resources to return.

collectionId Query Optional

Only return resources in this collection.

name Query Optional

Filter resources whose name contains this value.

private Query Optional

Filter by private or public visibility.

sort Query Optional

Sort field and direction.

fields Query Optional

Comma-separated response projection.

embed Query Optional

Set false to disable extras embedding.

GET /api/v1/resources/{resourceId}

Resources

Đọc resource public hoặc resource thuộc principal.

Auth Public hoặc resource:read

Parameters 1

resourceId Path Required

Identifier used in the endpoint path.

PUT /api/v1/resources/{resourceId}

Resources

Cập nhật resource bằng optimistic version.

Auth resource:write

Parameters 2

resourceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

PUT /api/v1/resources/{resourceId}/workspace

Resources

Chuyển ownership sang workspace hoặc cá nhân.

Auth resource:write

Parameters 2

resourceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

DELETE /api/v1/resources/{resourceId}

Resources

Xóa resource và dữ liệu phụ trợ.

Auth resource:write

Parameters 1

resourceId Path Required

Identifier used in the endpoint path.

GET /api/v1/resources/{resourceId}/versions

Resources

Liệt kê version đã nén của resource.

Auth resource:read

Parameters 1

resourceId Path Required

Identifier used in the endpoint path.

DELETE /api/v1/resources/{resourceId}/versions

Resources

Xóa lịch sử version.

Auth resource:write

Parameters 1

resourceId Path Required

Identifier used in the endpoint path.

POST /api/v1/resources/score-index/rebuild

Resources

Dựng lại score index từ nguồn dữ liệu chính.

Auth resource:write

GET /api/v1/resources/search

Resources

Tìm kiếm full-text và query JSON có giới hạn.

Auth search:read

Parameters 4

q Query Optional

Full-text search expression.

filter Query Optional

JSON filter expression.

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of matches to return.

POST /api/v1/resources/batch

Bulk jobs

Gửi batch atomic hoặc partial có idempotency.

Auth resource:write

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/resources/batch/{operationId}

Bulk jobs

Đọc kết quả batch đồng bộ hoặc bất đồng bộ.

Auth resource:read

Parameters 1

operationId Path Required

Identifier used in the endpoint path.

GET /api/v1/jobs/{jobId}

Bulk jobs

Theo dõi tiến độ import, export hoặc bulk job.

Auth Authenticated

Parameters 1

jobId Path Required

Identifier used in the endpoint path.

DELETE /api/v1/jobs/{jobId}

Bulk jobs

Yêu cầu hủy job chưa kết thúc.

Auth Authenticated

Parameters 1

jobId Path Required

Identifier used in the endpoint path.

POST /api/v1/collections

Collections

Tạo collection với JSON Schema và extras.

Auth collection:write

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/collections

Collections

Liệt kê collection của principal.

Auth collection:read

GET /api/v1/collections/{collectionId}

Collections

Đọc một collection.

Auth collection:read

Parameters 1

collectionId Path Required

Identifier used in the endpoint path.

PUT /api/v1/collections/{collectionId}

Collections

Cập nhật schema và extras.

Auth collection:write

Parameters 2

collectionId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

DELETE /api/v1/collections/{collectionId}

Collections

Xóa collection và bỏ liên kết resource.

Auth collection:write

Parameters 1

collectionId Path Required

Identifier used in the endpoint path.

POST /api/v1/workspaces

Workspaces

Tạo workspace.

Auth workspace:write

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/workspaces

Workspaces

Liệt kê workspace của principal.

Auth workspace:read

GET /api/v1/workspaces/{workspaceId}

Workspaces

Đọc chi tiết workspace.

Auth workspace:read

Parameters 1

workspaceId Path Required

Identifier used in the endpoint path.

PUT /api/v1/workspaces/{workspaceId}

Workspaces

Cập nhật tên hoặc slug workspace.

Auth workspace:write

Parameters 2

workspaceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

DELETE /api/v1/workspaces/{workspaceId}

Workspaces

Xóa workspace khi thỏa điều kiện ownership.

Auth workspace:write

Parameters 1

workspaceId Path Required

Identifier used in the endpoint path.

GET /api/v1/workspaces/{workspaceId}/resources

Workspaces

Liệt kê resource của workspace bằng cursor.

Auth workspace:read

Parameters 3

workspaceId Path Required

Identifier used in the endpoint path.

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

GET /api/v1/workspaces/{workspaceId}/members

Workspaces

Liệt kê thành viên.

Auth workspace:read

Parameters 1

workspaceId Path Required

Identifier used in the endpoint path.

POST /api/v1/workspaces/{workspaceId}/members

Workspaces

Thêm thành viên trực tiếp.

Auth workspace:write

Parameters 2

workspaceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

PUT /api/v1/workspaces/{workspaceId}/members/{userId}

Workspaces

Đổi vai trò thành viên.

Auth workspace:write

Parameters 3

workspaceId Path Required

Identifier used in the endpoint path.

userId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

DELETE /api/v1/workspaces/{workspaceId}/members/{userId}

Workspaces

Xóa thành viên.

Auth workspace:write

Parameters 2

workspaceId Path Required

Identifier used in the endpoint path.

userId Path Required

Identifier used in the endpoint path.

POST /api/v1/workspaces/{workspaceId}/invitations

Workspaces

Tạo invitation token có thời hạn.

Auth workspace:write

Parameters 2

workspaceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

GET /api/v1/workspaces/{workspaceId}/invitations

Workspaces

Liệt kê invitation đang quản lý.

Auth workspace:write

Parameters 1

workspaceId Path Required

Identifier used in the endpoint path.

DELETE /api/v1/workspaces/{workspaceId}/invitations/{invitationId}

Workspaces

Thu hồi invitation.

Auth workspace:write

Parameters 2

workspaceId Path Required

Identifier used in the endpoint path.

invitationId Path Required

Identifier used in the endpoint path.

POST /api/v1/workspaces/invitations/accept

Workspaces

Chấp nhận invitation token.

Auth workspace:write

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/resources/{resourceId}/comments

Collaboration

Đọc discussion bằng cursor.

Auth Authenticated

Parameters 3

resourceId Path Required

Identifier used in the endpoint path.

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

POST /api/v1/resources/{resourceId}/comments

Collaboration

Thêm comment và xử lý mention.

Auth Authenticated

Parameters 2

resourceId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

PUT /api/v1/comments/{commentId}

Collaboration

Sửa comment thuộc quyền tác giả.

Auth Authenticated

Parameters 2

commentId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

DELETE /api/v1/comments/{commentId}

Collaboration

Xóa mềm comment.

Auth Authenticated

Parameters 1

commentId Path Required

Identifier used in the endpoint path.

GET /api/v1/notifications

Collaboration

Liệt kê notification bằng cursor.

Auth Authenticated

Parameters 2

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

GET /api/v1/notifications/unread-count

Collaboration

Đếm notification chưa đọc.

Auth Authenticated

PUT /api/v1/notifications/{notificationId}/read

Collaboration

Đánh dấu một notification đã đọc.

Auth Authenticated

Parameters 2

notificationId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

PUT /api/v1/notifications/read-all

Collaboration

Đánh dấu toàn bộ notification đã đọc.

Auth Authenticated

POST /api/v1/transfers/uploads

Transfers

Upload file JSON, CSV hoặc XML.

Auth Authenticated

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/transfers/{transferId}/download-url

Transfers

Tạo signed download URL ngắn hạn.

Auth Authenticated

Parameters 1

transferId Path Required

Identifier used in the endpoint path.

GET /api/v1/transfers/download

Transfers

Tải object bằng signed token.

Auth Signed token

POST /api/v1/imports

Transfers

Khởi tạo import job.

Auth Authenticated

Parameters 1

body JSON body Required

Request payload documented by this operation.

POST /api/v1/exports

Transfers

Export đồng bộ hoặc đưa vào queue.

Auth Authenticated

Parameters 1

body JSON body Required

Request payload documented by this operation.

POST /api/v1/webhooks

Webhooks

Tạo webhook và trả secret một lần.

Auth Authenticated

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/webhooks

Webhooks

Liệt kê webhook.

Auth Authenticated

GET /api/v1/webhooks/{webhookId}

Webhooks

Đọc cấu hình webhook.

Auth Authenticated

Parameters 1

webhookId Path Required

Identifier used in the endpoint path.

PUT /api/v1/webhooks/{webhookId}

Webhooks

Cập nhật endpoint và subscriptions.

Auth Authenticated

Parameters 2

webhookId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

POST /api/v1/webhooks/{webhookId}/rotate-secret

Webhooks

Xoay signing secret.

Auth Authenticated

Parameters 1

webhookId Path Required

Identifier used in the endpoint path.

DELETE /api/v1/webhooks/{webhookId}

Webhooks

Xóa webhook.

Auth Authenticated

Parameters 1

webhookId Path Required

Identifier used in the endpoint path.

GET /api/v1/webhooks/{webhookId}/deliveries

Webhooks

Đọc delivery history.

Auth Authenticated

Parameters 3

webhookId Path Required

Identifier used in the endpoint path.

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

POST /api/v1/webhook-deliveries/{deliveryId}/replay

Webhooks

Replay một delivery thất bại.

Auth Authenticated

Parameters 1

deliveryId Path Required

Identifier used in the endpoint path.

POST /api/v1/domains

Custom domains

Đăng ký custom domain và verification token.

Auth Authenticated

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/domains

Custom domains

Liệt kê custom domain.

Auth Authenticated

GET /api/v1/domains/{domainId}

Custom domains

Đọc DNS và certificate status.

Auth Authenticated

Parameters 1

domainId Path Required

Identifier used in the endpoint path.

POST /api/v1/domains/{domainId}/verify

Custom domains

Kiểm tra TXT và CNAME ownership.

Auth Authenticated

Parameters 1

domainId Path Required

Identifier used in the endpoint path.

POST /api/v1/domains/{domainId}/certificate/retry

Custom domains

Yêu cầu thử cấp certificate lại.

Auth Authenticated

Parameters 1

domainId Path Required

Identifier used in the endpoint path.

DELETE /api/v1/domains/{domainId}

Custom domains

Thu hồi route và giải phóng domain.

Auth Authenticated

Parameters 1

domainId Path Required

Identifier used in the endpoint path.

GET /api/v1/audit-logs

Operations

Đọc audit log của actor.

Auth Authenticated

Parameters 2

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

GET /api/v1/audit-logs/settings

Operations

Đọc chính sách lưu trữ audit log.

Auth Authenticated

GET /api/v1/workspaces/{workspaceId}/audit-logs

Operations

Đọc audit log trong workspace.

Auth Authenticated

Parameters 3

workspaceId Path Required

Identifier used in the endpoint path.

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

GET /api/v1/usage/current

Operations

Đọc usage hiện tại theo chu kỳ.

Auth Authenticated

GET /api/v1/usage/history

Operations

Đọc usage archive.

Auth Authenticated

GET /api/v1/dashboard

Operations

Đọc dashboard summary.

Auth Authenticated

GET /api/v1/realtime/stream

Operations

Mở SSE stream cá nhân hoặc workspace.

Auth Authenticated

GET /api/v1/admin/analytics

Administration

Đọc analytics rollup.

Auth ADMIN

GET /api/v1/admin/users

Administration

Liệt kê user.

Auth ADMIN

PUT /api/v1/admin/users/{userId}/tier

Administration

Thay đổi tier user.

Auth ADMIN

Parameters 2

userId Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

GET /api/v1/admin/tiers

Administration

Đọc cấu hình tier.

Auth ADMIN

GET /api/v1/admin/infrastructure

Administration

Đọc mức sử dụng hạ tầng.

Auth ADMIN

GET /api/v1/admin/audit-settings

Administration

Đọc cấu hình audit log.

Auth ADMIN

PUT /api/v1/admin/audit-settings

Administration

Cập nhật cấu hình audit log.

Auth ADMIN

Parameters 1

body JSON body Required

Request payload documented by this operation.

GET /api/v1/admin/platform-settings

Administration

Đọc cấu hình public API URL.

Auth ADMIN

PUT /api/v1/admin/platform-settings

Administration

Cập nhật public API URL.

Auth ADMIN

Parameters 1

body JSON body Required

Request payload documented by this operation.

POST /api/v1/admin/tiers

Administration

Tạo tier mới.

Auth ADMIN

Parameters 1

body JSON body Required

Request payload documented by this operation.

PUT /api/v1/admin/tiers/{tier}

Administration

Cập nhật giới hạn tier.

Auth ADMIN

Parameters 2

tier Path Required

Identifier used in the endpoint path.

body JSON body Required

Request payload documented by this operation.

GET /api/v1/admin/usage

Administration

Đọc usage toàn hệ thống.

Auth ADMIN

GET /api/v1/admin/jobs

Administration

Quan sát job backlog và failure.

Auth ADMIN

GET /api/v1/admin/webhook-failures

Administration

Quan sát webhook failure.

Auth ADMIN

GET /api/v1/admin/audit-logs

Administration

Đọc audit log toàn hệ thống.

Auth ADMIN

Parameters 2

cursor Query Optional

Cursor returned by the previous page.

limit Query Optional

Maximum number of records to return.

GET /api/v1/admin/domain-routes/{host}

Administration

Kiểm tra route registry theo host.

Auth ADMIN

Parameters 1

host Path Required

Identifier used in the endpoint path.

Conventions

Cursor pagination

Use cursor returned from response instead of large offset.

Optimistic version

Send the current version when updating or deleting a versioned resource.

Idempotency

Send Idempotency-Key for retryable batches.

Rate limits

Read limit, remaining, reset, and Retry-After from the response headers.

Base path

Public base URL

X-API-Key

Open Parameters to see the position and required level of each parameter.

endpoints

Endpoint not found

Conventions