This help should be accurate and comprehensive. If you see anything missing or that needs to be fixed, see How to Contribute or let us know in the Juice Slack #documentation channel.

Authentication to the API is handled via a token that is placed into the header of every request. To obtain your token, you need to make a POST request to the /api/v1/api-token-auth/ endpoint. Once you have your token, you will include it in request header as the Authorization key, and the value should be Token <token_value> where <token_value> is the token returned by this endpoint.

POST /api/v1/api-token-auth/

Get a Authentication token.

Example Request:

POST /api/v1/api-token-auth/
Accept: application/json
  "username": "",
  "password": "SomeSecretPassword"

Example Response:

 HTTP/1.1 200 OK
 Vary: Accept
 Content-Type: text/javascript

  "token": "7297b3ebb0e7f7baf5f54d39908dda99f5ea8665"
Request JSON Object:
  • username (string) – the email address of the user
  • password (string) – the password for the user
Response JSON Object:
  • token (string) – the token to be used in future requests
Request Headers:
  • Accept – the response content type depends on Accept header
Response Headers:
Status Codes: