Skip to content

API Explorer

What it is and why use it

API Explorer is an in-console helper to call /api/v1 endpoints with your current session JWT — useful for admins validating integrations without curl.

Before you start

  • Enterprise plan, admin role, advanced navigation enabled.
  • Prefer the hosted OpenAPI UI at /api/docs for full schema browsing.

Step by step

  1. Open API Explorer (/api-explorer).

Vex Raptor console — api-explorer-blank

  1. Pick method and path (e.g. GET /api/v1/auth/me).

  2. Add JSON body if required and Send.

Vex Raptor console — api-explorer-response

  1. Copy responses into your integration notes — never share JWTs.

What you will see

Raw status code, headers summary, and JSON body from the API.

Common problems

  • Hidden menu — enterprise + advanced nav required.
  • 401 — session expired; log in again.

Next steps