Shipeasy
Flags experimentsApiOperations

Get an event

Returns one event's full detail. Resolves by exact id, unique id-prefix, or exact (unique) name.

Returns one event's full detail. Resolves by exact id, unique id-prefix, or exact (unique) name.

Use case

Inspect one event's declared properties and pending state by id or name.

GET
/api/admin/events/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque event id (evt_…) or the event's name.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/events/string"
{
  "id": "evt_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "name": "checkout_completed",
  "folder": "checkout",
  "description": "Fired when a customer finishes checkout.",
  "properties": [
    {
      "name": "amount",
      "type": "number",
      "required": true,
      "description": ""
    }
  ],
  "pending": 0,
  "createdAt": "2026-04-12T10:14:08.000Z"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page