Authenticate
Login to Violet using your App Secret and App Id, retrieved from channel.violet.io. This is required to receive an Access Token, which is used to authenticate requests made to Violet.
Header parameters
X-Violet-App-SecretstringRequired
Please note that App Secrets are different depending on environment (test/live) please make sure you have retrieved the correct app secret from the Dashboard.
X-Violet-App-Idinteger · int32Required
Body
Login Request
usernamestringRequired
Username
passwordstringRequired
Password
Responses
default
default response
application/json
post
POST /v1/login HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"username": "text",
"password": "text"
}
default
default response
{
"id": 1,
"first_name": "text",
"last_name": "text",
"password": "text",
"email": "text",
"type": "SUPER_ADMIN",
"verified": true,
"status": "inactive",
"date_created": "2025-07-10T05:13:15.664Z",
"date_last_modified": "2025-07-10T05:13:15.664Z",
"roles": [
{
"name": "text",
"permissions": [
{
"name": "text",
"description": "text"
}
]
}
],
"tos_accepted": true,
"payment_configured": true,
"privacy_policy_accepted": true,
"country_code": "US",
"token": "text",
"refresh_token": "text",
"merchant_id": 1,
"merchant_ids": [
1
],
"store_url": "text"
}
Last updated
Was this helpful?