Login

POST /session/login

Log in to your Litmind account. This is needed for all endpoints that perform actions related to your account at Litmind (for example: retrieving a list of candidate models in your castings)

Headers

Name
Required
Value

X-Key

Your API Key

X-SessionId

Your session id. If not specified, a new session will be created

Body

Name
Description
Required

emailOrUsername

The username or the email of your Litmind account

password

The password of your Litmind account

Example

curl \
    -X POST https://litmind.com/api/v1/session/login \
    -H 'X-Key: bfRCu5GAEP9eMZ7fS6yvPwGxB9Nu7FzUfdnasrCkKkHAyCBZ' \
    -d 'emailOrUsername=imagine-production&password=Dq4juHcnJBw8'

Response

{
    "entity": "Login",
    "isSuccess": true,
    "errorDescription": null,
    "sessionId": "313599f212429860887ef23ea326cc863a9186eb1a43a8f1739a1815ebe2a588",
    "profile": {
        <Profile entity>
    }
}
  • isSuccess Whether the login was performed successfully.

  • errorDescription If there was an error while logging in, a description.

  • sessionId Your session id, to be passed from now on as the value for the X-SessionId header when making requests that require it.

  • profile.id Your user id, to be passed from now on as the value for the X-UserId header when making requests that require it.

Last updated