# Beamable history basic API

> Beamable history basic API on Apizie: 325 endpoints (GET /basic/trials/admin/data, POST /basic/trials/data, DELETE /basic/trials/data, PUT /basic/trials/pause, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/dev-tools:beamable/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:beamable`
- Category: Dev Tools
- Status: byok
- Source: https://beamable.com
- Page: https://zieapi.vercel.app/api/dev-tools/beamable
- OpenAPI: https://zieapi.vercel.app/api/dev-tools/beamable/openapi.json

var Beamable = BeamContext.Default; - That one line of code is a gateway to everything you need to build custom server logic via microservices along with a world of LiveOps tools and live services to build games that…

## Endpoints

### GET /basic/trials/admin/data
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/trial-admin-data-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |

### POST /basic/trials/data
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/trial-post-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### DELETE /basic/trials/data
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/trial-delete-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### PUT /basic/trials/pause
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/trial-pause-trial` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### PUT /basic/trials/schedule
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/trial-schedule-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/trials/admin
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/trial-get-admin-trials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dbid | integer | yes |  |

### PUT /basic/trials/start
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/trial-start-trial-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### DELETE /basic/accounts/me/device
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-remove-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/accounts/me
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-get-user-info` (byok)

### PUT /basic/accounts/me
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-account-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### DELETE /basic/accounts/me/third-party
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-delete-third-party` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/accounts/get-personally-identifiable-information
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-get-personally-identifiable-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | yes |  |

### GET /basic/accounts/search
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-search-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | yes |  |
| page | integer | yes |  |
| pagesize | integer | yes |  |

### POST /basic/accounts/email-update/init
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/mail-update-email-init` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /basic/accounts/email-update/confirm
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/mail-update-email-confirmation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/accounts/available/third-party
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-check-third-party-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| thirdParty | string | yes |  |
| token | string | yes |  |

### POST /basic/accounts/admin/admin-user
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-create-admin-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /basic/accounts/register
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-register-new-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/accounts/admin/me
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-get-details` (byok)

### POST /basic/accounts/password-update/init
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-password-init` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/accounts/admin/admin-users
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-get-admin-users` (byok)

### GET /basic/accounts/find
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-find-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | yes |  |

### GET /basic/accounts/available/device-id
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-check-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| deviceId | string | yes |  |

### GET /basic/accounts/available
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-check-availability-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email | string | yes |  |

### POST /basic/accounts/password-update/confirm
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-password-confirmation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### PUT /object/accounts/{objectId}/admin/email
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/mail-update-admin-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/accounts/{objectId}/available-roles
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/account-get-object-available-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### PUT /object/accounts/{objectId}/role
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/accounts/{objectId}/role
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-remove-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### PUT /object/accounts/{objectId}/admin/scope
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-admin-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/accounts/{objectId}/admin/scope
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-delete-admin-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### PUT /object/accounts/{objectId}/admin/third-party
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-update-third-party-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/accounts/{objectId}/admin/third-party
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-delete-third-party-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/accounts/{objectId}/admin/forget
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/account-remove-admin-forget` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### GET /basic/announcements/search
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/announcement-search-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| date | string | no |  |

### GET /basic/announcements/content
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-announcement-content` (byok)

### GET /basic/announcements/list
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/announcement-get-all-announcements` (byok)

### PUT /object/announcements/{objectId}/read
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/announcement-mark-as-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/announcements/{objectId}/claim
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/announcement-claim-object-announcement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/announcements/{objectId}/raw
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/announcement-get-object-raw` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### GET /basic/auth/token
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/authentication-get-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| token | string | no |  |

### POST /basic/auth/token
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/authentication-request-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /object/calendars/{objectId}/claim
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-claim-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/chatV2/{objectId}/rooms
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-chat-rooms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### POST /object/chatV2/{objectId}/rooms
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-create-chat-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/chatV2/{objectId}/rooms
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-delete-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/chatV2/{objectId}/messages
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/message-send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /basic/cloudsaving/data/replace
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-replace-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### DELETE /basic/cloudsaving/data
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-delete-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /basic/cloudsaving/data/downloadURL
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-get-data-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/cloudsaving/data/metadata
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-get-data-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| request | array | no |  |
| playerId | integer | no |  |

### PUT /basic/cloudsaving/data/move
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-move-data-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /basic/cloudsaving/data/uploadURLFromPortal
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-upload-url-from-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### PUT /basic/cloudsaving/data/commitManifest
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-commit-manifest-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /basic/cloudsaving/data/uploadURL
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/cloudsaving-upload-data-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/commerce/catalog
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/product-get-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| version | integer | no |  |

### GET /basic/commerce/skus
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/sku-list-skus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| version | integer | no |  |

### POST /basic/commerce/skus
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/sku-create-sku` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /object/commerce/{objectId}/coupons/count
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-commerce-coupon-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### GET /object/commerce/{objectId}/offersAdmin
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-offers-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| language | string | no |  |
| time | string | no |  |
| stores | string | no |  |
| objectId | string | yes |  |

### POST /object/commerce/{objectId}/purchase
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-purchase-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/commerce/{objectId}/purchase
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-purchase-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/commerce/{objectId}/listings
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-commerce-listings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listing | string | no |  |
| store | string | no |  |
| time | string | no |  |
| objectId | string | yes |  |

### DELETE /object/commerce/{objectId}/status
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-delete-status-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/commerce/{objectId}/coupons
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-create-commerce-coupons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/commerce/{objectId}/stats/update
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-update-stat-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/commerce/{objectId}/offers
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-commerce-offers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| language | string | no |  |
| time | string | no |  |
| stores | string | no |  |
| objectId | string | yes |  |

### POST /basic/content/manifest/pull
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-pull-manifest-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/content/content
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-content-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contentId | string | no |  |
| version | string | no |  |

### POST /basic/content/text
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-submit-text-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/content/manifest
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-manifest-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |

### POST /basic/content/manifest
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-create-manifest-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/content/manifest/public
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-public-manifest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |

### GET /basic/content/manifest/private
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-private-manifest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |

### GET /basic/content/manifest/checksum
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-check-manifest-checksum` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |

### GET /basic/events/content
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/content-get-content-data` (byok)

### GET /basic/events/calendar
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/event-get-calendar-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | no |  |
| to | string | no |  |
| query | string | no |  |
| limit | integer | no |  |

### POST /basic/events/applyContent
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-apply-content-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /basic/events/running
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/activity-get-running-events` (byok)

### PUT /object/events/{objectId}/endPhase
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/event-update-object-end-phase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/events/{objectId}/ping
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/event-ping-object-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### PUT /object/events/{objectId}/content
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-update-object-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/events/{objectId}/content
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/content-delete-event-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### PUT /object/events/{objectId}/refresh
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/event-refresh-object-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### POST /object/event-players/{objectId}/claim
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/event-claim-object-event-players` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/event-players/{objectId}/score
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/event-update-player-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/gamerelay/{objectId}/sync
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/game-relay-object-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/gamerelay/{objectId}/results
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/game-relay-object-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/inventory/{objectId}/preview
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-update-inventory-preview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/inventory/{objectId}/multipliers
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/object-get-multipliers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### DELETE /object/inventory/{objectId}/transaction
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-remove-transaction-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/inventory/{objectId}/transfer
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/object-transfer-item-inventory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /basic/inventory/items
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/item-list-items` (byok)

### GET /basic/inventory/currency
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/currency-get-inventory-currency` (byok)

### GET /basic/leaderboards/list
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-list-user-scores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### GET /basic/leaderboards/player
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-player-scores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dbid | integer | yes |  |

### GET /basic/leaderboards/assignment
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-assignment-leaderboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| boardId | string | yes |  |
| joinBoard | boolean | no |  |

### GET /basic/leaderboards/uid
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-user-scores` (byok)

### DELETE /object/leaderboards/{objectId}/entries
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-delete-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/membership
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-object-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| playerId | integer | yes |  |
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/ranks
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-list-object-ranks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no |  |
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/partition
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-object-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| playerId | integer | yes |  |
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/matches
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-object-matches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| poolSize | integer | yes |  |
| windows | integer | yes |  |
| windowSize | integer | yes |  |
| objectId | string | yes |  |

### DELETE /object/leaderboards/{objectId}/assignment
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-remove-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/leaderboards/{objectId}/entry
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-update-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/leaderboards/{objectId}/entry
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-remove-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/leaderboards/{objectId}/freeze
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-create-freeze-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/details
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-object-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | integer | no |  |
| max | integer | no |  |
| objectId | string | yes |  |

### GET /object/leaderboards/{objectId}/view
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-get-object-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| max | integer | no |  |
| focus | integer | no |  |
| friends | boolean | no |  |
| from | integer | no |  |
| outlier | integer | no |  |
| guild | boolean | no |  |
| objectId | string | yes |  |

### PUT /object/leaderboards/{objectId}/swap
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/leaderboard-swap-object-leaderboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /basic/groups/search
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/group-search-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no |  |
| scoreMin | integer | no |  |
| sortField | string | no |  |
| userScore | integer | no |  |
| hasSlots | boolean | no |  |
| enrollmentTypes | string | no |  |
| offset | integer | no |  |
| scoreMax | integer | no |  |
| subGroup | boolean | no |  |
| sortValue | integer | no |  |
| type | string | no |  |
| limit | integer | no |  |

### PUT /object/groups/{objectId}/role
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-update-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/groups/{objectId}/kick
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-kick-object-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/groups/{objectId}/apply
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-apply-object-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/groups/{objectId}/donations
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-create-donation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### PUT /object/groups/{objectId}/donations
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-update-donation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### DELETE /object/groups/{objectId}/member
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-remove-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/groups/{objectId}/invite
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-invite-object-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### POST /object/groups/{objectId}/petition
`POST https://zieapi.vercel.app/v1/dev-tools:beamable/group-create-petition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectId | string | yes |  |
| body | object | no | JSON request body |

### GET /object/group-users/{objectId}/availability
`GET https://zieapi.vercel.app/v1/dev-tools:beamable/group-get-user-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no |  |
| tag | string | no |  |
| type | string | no |  |
| subGroup | boolean | no |  |
| objectId | string | yes |  |

…and 205 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/dev-tools:beamable/trial-admin-data-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Beamable history basic API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/dev-tools:beamable/trial-admin-data-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Beamable history basic API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Beamable history basic itself also needs your own key from api.beamable.com.

### Can AI agents use the Beamable history basic API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:beamable.

### What is the status of the Beamable history basic API?
Needs your own provider key (bring your own key)