Using the Vorx API

Use the Vorx GraphQL API when you want to read or update workspace data from outside the app — backups, internal tools, or automations you run yourself.

This is different from APIs and automations inside a generated app (calling Stripe, Slack, and so on). Here you are calling Vorx as the client.

Create an API key

1. Open Settings → Personal → API keys.
2. Click Create API key and give it a label.
3. Copy the key when it is shown. Vorx only displays the full secret once.

Keys look like vorx_api_ followed by a long random string.

Authenticate

Send the key as a Bearer token on every request:

Authorization: Bearer vorx_api_your_key_here

No session cookie or company header is required — the key is already scoped to your user and workspace.

Endpoint

POST https://www.vorx.com/graphql
Content-Type: application/json

Example request

curl https://www.vorx.com/graphql \
  -H "Authorization: Bearer vorx_api_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"query":"{ currentEmail companies { nodes { id name code } } }"}'

A successful response includes your email and the companies the key can access. From there you can query projects, members, and other workspace data the same way the Vorx app does.

Keep keys safe

• Treat the key like a password — do not commit it or put it in client-side code.
• Prefer environment variables or a secret store in your scripts.
• Revoke a key anytime from Settings → API keys if it leaks or you no longer need it.

Related

• Secrets — credentials your generated apps use to call other services.
• APIs and automations — calling external APIs from inside a Vorx app.