Beladed mark Beladed Docs
Help Sign in Create account

Beladed Events API

Get By Name

beta

Get By Name through the reviewed Beladed Events contract.

GET/api/events/general/get
curl --request GET 'https://api.beladed.dev/api/events/general/get?name=example_name&eventId=id_demo_001&exclude=marketingAssets&include=marketingAssets&shortId=id_demo_001' \
  --header 'Accept: application/json'

Parameters

namequeryoptional

string — Filter by name.

Example: example_name

eventIdqueryoptional

string — Filter by eventId.

Example: id_demo_001

excludequeryoptional

string — Filter by exclude.

Example: marketingAssets

includequeryoptional

string — Filter by include.

Example: marketingAssets

shortIdqueryoptional

string — Filter by shortId.

Example: id_demo_001

Request body

No body is required.

Responses

200The request succeeded.
Responseapplication/jsonClient handling: raw JSON
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
{
  "data": {
    "id": "id_demo_001",
    "status": "available"
  },
  "requestId": "req_demo_001"
}

Errors

400invalid_request

The request did not satisfy the documented contract.

404not_found

The requested public or account-owned resource was not found.

429rate_limited

Retry after the current product limit resets.

Reliability

Idempotency
Read-only operation.
Pagination
Not applicable.
Rate limit
Subject to current account, product, and abuse-protection limits. Honor Retry-After when returned.
Webhook events
No related public event is declared.

Contract provenance

This operation is published from reviewed route, handler, and test contracts. Internal implementation paths remain private.

Contract owner
Beladed Events API team
Verification
Route and collection reviewed
Reviewed
2026-07-12
Mark this page
Share details
Type to search the complete public documentation catalog.