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.

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.

Example:

"viq_bcmig_Ab12Cd34Ef56Gh78Ij90Kl12"

client_secret
string
required

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

Example:

"<client-secret>"

Response

Authenticated. Send access_token as Authorization: Bearer <token> on every subsequent call.

user
object
organization
object
stores
object[]

The BigCommerce stores connected to your organisation. Use these store hashes on the migration endpoints.

token_type
string
Example:

"Bearer"

access_token
string

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

expires_in
integer

Token lifetime in seconds (864000 = 10 days).

Example:

864000

expires_at
string<date-time>

Absolute expiry time (ISO 8601).