User Login

Exchanges username, password, and application key for a persistent API key scoped to that user and application. No pre-existing authentication is required; credentials are passed in the request body. On success, returns a persistent API key, the authenticated user ID, the linked employee ID (null when no employee record is associated), and the base API URL to use for subsequent requests.

This endpoint is deprecated. New integrations should prefer OAuth or OpenID Connect instead.

applicationKey must correspond to a registered non-mobile application; iOS and Android app keys are explicitly rejected with a 403 (no body). The optional deviceId associates the generated key with a specific device.

Response format is determined by the Accept request header. Send Accept: application/json to receive JSON; omit the header or send any other value to receive XML. Alternatively, set ?format=json in the query string to force JSON regardless of the Accept header.

Note: If the company has SSO enabled and password login is disabled, this endpoint returns HTTP 200 with a plain-text error message rather than a structured error response.

Query Params
string
enum

When set to json, forces a JSON response regardless of the Accept header.

Allowed:
Form Data
string
required

The API key of the registered application making the login request. Mobile application keys (iOS/Android) are not accepted.

string
required

The user's email address or username.

password
required

The user's password.

string

Optional device identifier. When provided, the generated API key is associated with this device.

Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json