Juicebox API

The Juicebox API can be used for generating urls to embed apps in your webpage.

get

List Access Views

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/access_views/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

[
  {
    "created": "2025-04-03T23:35:59.412Z",
    "modified": "2025-04-03T23:35:59.412Z",
    "key": "text",
    "is_active": true,
    "allowed_uses_cnt": 1,
    "usages_cnt": 1,
    "expires_at": "2025-04-03T23:35:59.412Z",
    "data_permissions": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "selections": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "show_header": true,
    "language_code": "text",
    "app": "text"
  }
]

post

List Access Views

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

createdstring · date-timeread-onlyrequired

modifiedstring · date-timeread-onlyrequired

keystringread-onlyrequired

is_activebooleanoptional

Can this access key be used

allowed_uses_cntinteger · min: -2147483648 · max: 2147483647optional

The number of times this access key CAN BE used. 0=unlimited uses

usages_cntintegerread-onlyrequired

The number of times this access key HAS BEEN used

expires_atstring · date-time | nullableoptional

data_permissionsobjectoptional

A Juicebox data permissions object, like a user extra

selectionsobjectoptional

A Juicebox selections object

show_headerbooleanoptional

language_codestring · max: 2optional

appstringrequired

The app this key is granting access to

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/access_views/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_active": true,
    "allowed_uses_cnt": 1,
    "expires_at": "2025-04-03T23:35:59.412Z",
    "data_permissions": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "selections": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "show_header": true,
    "language_code": "text",
    "app": "text"
  }'

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201

201

{
  "created": "2025-04-03T23:35:59.412Z",
  "modified": "2025-04-03T23:35:59.412Z",
  "key": "text",
  "is_active": true,
  "allowed_uses_cnt": 1,
  "usages_cnt": 1,
  "expires_at": "2025-04-03T23:35:59.412Z",
  "data_permissions": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "selections": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "show_header": true,
  "language_code": "text",
  "app": "text"
}

get

Get an Access View

Authorizations

Path parameters

keystringrequiredPattern: ^\w+$

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/access_views/{key}/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "created": "2025-04-03T23:35:59.412Z",
  "modified": "2025-04-03T23:35:59.412Z",
  "key": "text",
  "is_active": true,
  "allowed_uses_cnt": 1,
  "usages_cnt": 1,
  "expires_at": "2025-04-03T23:35:59.412Z",
  "data_permissions": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "selections": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "show_header": true,
  "language_code": "text",
  "app": "text"
}

put

Modify an Access View

Authorizations

Path parameters

keystringrequiredPattern: ^\w+$

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

createdstring · date-timeread-onlyrequired

modifiedstring · date-timeread-onlyrequired

keystringread-onlyrequired

is_activebooleanoptional

Can this access key be used

allowed_uses_cntinteger · min: -2147483648 · max: 2147483647optional

The number of times this access key CAN BE used. 0=unlimited uses

usages_cntintegerread-onlyrequired

The number of times this access key HAS BEEN used

expires_atstring · date-time | nullableoptional

data_permissionsobjectoptional

A Juicebox data permissions object, like a user extra

selectionsobjectoptional

A Juicebox selections object

show_headerbooleanoptional

language_codestring · max: 2optional

appstringrequired

The app this key is granting access to

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/access_views/{key}/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_active": true,
    "allowed_uses_cnt": 1,
    "expires_at": "2025-04-03T23:35:59.412Z",
    "data_permissions": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "selections": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "show_header": true,
    "language_code": "text",
    "app": "text"
  }'

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200

200

{
  "created": "2025-04-03T23:35:59.412Z",
  "modified": "2025-04-03T23:35:59.412Z",
  "key": "text",
  "is_active": true,
  "allowed_uses_cnt": 1,
  "usages_cnt": 1,
  "expires_at": "2025-04-03T23:35:59.412Z",
  "data_permissions": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "selections": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "show_header": true,
  "language_code": "text",
  "app": "text"
}

delete

Deleting an access view will set the is_active flag to False.

Authorizations

Path parameters

keystringrequiredPattern: ^\w+$

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/access_views/{key}/' \
  --header 'Authorization: YOUR_API_KEY'

204

204

No body

The access view has been set to inactive.

patch

Modify an Access View

Authorizations

Path parameters

keystringrequiredPattern: ^\w+$

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

createdstring · date-timeread-onlyoptional

modifiedstring · date-timeread-onlyoptional

keystringread-onlyoptional

is_activebooleanoptional

Can this access key be used

allowed_uses_cntinteger · min: -2147483648 · max: 2147483647optional

The number of times this access key CAN BE used. 0=unlimited uses

usages_cntintegerread-onlyoptional

The number of times this access key HAS BEEN used

expires_atstring · date-time | nullableoptional

data_permissionsobjectoptional

A Juicebox data permissions object, like a user extra

selectionsobjectoptional

A Juicebox selections object

show_headerbooleanoptional

language_codestring · max: 2optional

appstringoptional

The app this key is granting access to

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/v1/access_views/{key}/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_active": true,
    "allowed_uses_cnt": 1,
    "expires_at": "2025-04-03T23:35:59.412Z",
    "data_permissions": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "selections": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "show_header": true,
    "language_code": "text",
    "app": "text"
  }'

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200

200

{
  "created": "2025-04-03T23:35:59.412Z",
  "modified": "2025-04-03T23:35:59.412Z",
  "key": "text",
  "is_active": true,
  "allowed_uses_cnt": 1,
  "usages_cnt": 1,
  "expires_at": "2025-04-03T23:35:59.412Z",
  "data_permissions": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "selections": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "show_header": true,
  "language_code": "text",
  "app": "text"
}

get

List Access Views

Authorizations

Path parameters

keystringrequiredPattern: ^\w+$

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/access_views/{key}/usage/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

[
  {
    "data_permissions": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "selections": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "app_slug": "text",
    "show_header": true,
    "language_code": "text",
    "timestamp": "2025-04-03T23:35:59.412Z"
  }
]

post

For backward compatibility with some client's integrations that have hardcoded 200, we remap status 201 to 200.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer class used to validate a username and password.

'username' is identified by the custom UserModel.USERNAME_FIELD.

Returns a JSON Web Token that can be used to authenticate later calls.

passwordstringwrite-onlyrequired

tokenstringread-onlyrequired

emailstringwrite-onlyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/jb/api-token-auth/' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "text",
    "email": "text"
  }'

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200

200

{
  "token": "text"
}

get

Get a list of apps, new apps are created using the Juicebox editor.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/jb/apps/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

[
  {
    "client_id": "text",
    "created_at": "2025-04-03T23:35:59.412Z",
    "description": "text",
    "footer_html": "text",
    "help_html": "text",
    "id": "text",
    "in_maintenance": true,
    "invitation_body": "text",
    "invitation_subject": "text",
    "label": "text",
    "maintenance_message": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "package_info": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "raw_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "show_footer": true,
    "show_help": true,
    "slug": "text",
    "usage": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "users": [
      1
    ]
  }
]

delete

Allow deleting redis cache for any app that the requesting user can modify.

Authorizations

Path parameters

idstringrequiredPattern: ^\w+(:\w+)?$

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/jb/apps/{id}/clear_cache/' \
  --header 'Authorization: YOUR_API_KEY'

204

204

No body

No response body