Skip to content
English

Get a user token

POST/v1/auth/token

Issues an access token for one hour based on login and password. Specify mode=account to access all account mailboxes or mode=mailbox to access one address. Pass access_token in the Authorization: Bearer <access_token> header.

Authentication and access · Errors and retries

Request

Terminal window
curl -X POST 'https://adapt-mail.com/v1/auth/token' \
-H 'Content-Type: application/json' \
--data '{"login":"user-123","password":"<password>"}'

Request body · application/json

object

loginNecessarily

string

passwordNecessarily

string

minLength: 1

maxLength: 128

mode

string

Valid values: "account" "mailbox"

Default: "account"

Unknown fields are not accepted.

Responses

200 Successful response

application/json

object

access_token

string

token_type

string

"Bearer"

expires_in

integer

3600

mailbox_id
Option 1

integer

Option 2

null

401 Login required

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

403 No access

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

404 Resource not found

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

409 State conflict

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

422 Validation error

application/json

object

detail

array

Array elements

object

locNecessarily

array

Array elements
Option 1

string

Option 2

integer

msgNecessarily

string

typeNecessarily

string

429 Too many requests

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

503 Temporarily unavailable

application/json

object

detail
Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object