Access token - Box Dev Docs

API version 2024.0 A token that can be used to make authenticated API calls.

access_token

string(token)

example: c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQThe requested access token.

expires_in

integer(int64)

example: 3600The time in seconds by which this token will expire.

issued_token_type

string(urn)

example: urn:ietf:params:oauth:token-type:access_tokenThe type of downscoped access token returned. This is only returned if an access token has been downscoped.Value is always urn:ietf:params:oauth:token-type:access_token

refresh_token

string(token)

example: c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQThe refresh token for this access token, which can be used to request a new access token when the current one expires.

restricted_to

object[]

The permissions that this access token permits, providing a list of resources (files, folders, etc) and the scopes permitted for each of those resources.

Show child attributes

object

File (Mini)/Folder (Mini)object

The file or folder resource.

scope

string

example: item_downloadThe scopes for the resource access.Value is one of annotation_edit,annotation_view_all,annotation_view_self,base_explorer,base_picker,base_preview,base_upload,item_delete,item_download,item_preview,item_rename,item_share,item_upload,item_read

token_type

string

example: bearerThe type of access token returned.Value is always bearer

{
  "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
  "expires_in": 3600,
  "issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
  "refresh_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
  "restricted_to": [
    {
      "object": {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      },
      "scope": "item_download"
    }
  ],
  "token_type": "bearer"
}