Skip to main content
POST
Login

Body

application/json
username
string
required

Your name as registered on your Vortex IQ account (first name, last name, or full name; case-insensitive).

Example:

"Jane Merchant"

email
string<email>
required

The email of your Vortex IQ user. The account must be active.

Example:

"jane@example.com"

organization_name
string
required

Your organisation's name exactly as registered (case-insensitive). Your user must belong to this organisation.

Example:

"Example Retail Ltd"

client_id
string
required

Your organisation's API client id, issued by Vortex IQ. It starts with viq_auto_.

Example:

"viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12"

client_secret
string
required

Your organisation's API client secret. Shown once at issue time; keep it server-side.

Example:

"<client-secret>"

grant_type
enum<string>

Optional. Sent by OAuth 2.0 clients; when present it must be client_credentials.

Available options:
client_credentials

Response

Authenticated. Send access_token as Authorization: Bearer <token> on every call to https://automations-api.vortexiq.ai.

access_token
string

The bearer token (a signed JWT). Treat it as a secret.

token_type
string
Example:

"Bearer"

expires_in
integer

Token lifetime in seconds (3600, one hour).

Example:

3600

expires_at
string<date-time>

Absolute expiry time (ISO 8601).

scope
string

What the token may do, space-separated. A credential's token never holds automations:approve.

Example:

"automations:read automations:write"

service_url
string

Where to send the token.

Example:

"https://automations-api.vortexiq.ai"

direct
boolean

Used by the Vortex IQ app's own screens. You can ignore it.

user
object
organization
object