API Version 1.2
API Documentation for developers
Login method
URL: /api/auth/login.format
Method: POST
Overview:
This method is used to login (i.e. fetch key to sign further requests) and fetch some basic information about users.
| name | type | description |
| login | string | User login (email address) |
| password | password | User password |
| NAME | TYPE | DESCRIPTION |
| uid | string | User’s unique ID, which is used during further request authorization |
| key | string | User key (bytes data Base64 format) which has to be used during further request authorization |
| firstname | string | User’s first name |
| lastname | string | User’s last name |
| company | string | User’s company name |
| listing | hash | Information about default mode of displayed contacts list (according to users settings). It consists of two elements:
|
| timezone | string | User’s timezone (in format +HH:MM/-HH:MM) |
| currency | hash | Information about user’s currency. Consists of two elements:
|
| pipeline_mode | string | Sales pipeline mode. One of three values: off, simple or full. See sales section for more details. |
| customerlabel | string | Label which is used to describe “customer” contact status |
| dateformat | string | Date format used by the user (e.g. dd/mm/yyyy) |
Sample JSON server response for login method
