Login
Exchange your identity (username, email, organisation name) and your organisation’s API credential
(client_id and client_secret) for a bearer token valid for 60 minutes. The credential is issued per
organisation by Vortex IQ: contact support to have one provisioned.
The token acts as the person you name, within their organisation, with the credential’s scopes
(automations:read automations:write). It never approves. Everything it creates is recorded as made by that
person through the API, with the credential’s client id.
Send the request as JSON, as here, or as an OAuth 2.0 client-credentials form
(application/x-www-form-urlencoded, grant_type=client_credentials) with the client id and secret as HTTP
Basic authentication and username, email and organization_name as extra form fields, which is what
Postman’s OAuth 2.0 helper sends. Values in the address are ignored: send everything in the body.
This endpoint is served by https://app.vortexiq.ai; every other endpoint by
https://automations-api.vortexiq.ai. Rate limited to 10 requests a minute.
Body
Your name as registered on your Vortex IQ account (first name, last name, or full name; case-insensitive).
"Jane Merchant"
The email of your Vortex IQ user. The account must be active.
"jane@example.com"
Your organisation's name exactly as registered (case-insensitive). Your user must belong to this organisation.
"Example Retail Ltd"
Your organisation's API client id, issued by Vortex IQ. It starts with viq_auto_.
"viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12"
Your organisation's API client secret. Shown once at issue time; keep it server-side.
"<client-secret>"
Optional. Sent by OAuth 2.0 clients; when present it must be client_credentials.
client_credentials Response
Authenticated. Send access_token as Authorization: Bearer <token> on every call to https://automations-api.vortexiq.ai.
The bearer token (a signed JWT). Treat it as a secret.
"Bearer"
Token lifetime in seconds (3600, one hour).
3600
Absolute expiry time (ISO 8601).
What the token may do, space-separated. A credential's token never holds automations:approve.
"automations:read automations:write"
Where to send the token.
"https://automations-api.vortexiq.ai"
Used by the Vortex IQ app's own screens. You can ignore it.