API

Our company creates a Workspace folder for each user that is owned by a central service account.  I’m trying to build a script with Box CLI and PowerShell to delete a user’s Workspace folder after we delete their account to free up a license. Every time I try to get the folder details or delete the folder, I’m greeted with a d_ prefix on the item and it can’t find the folder. If I try to just get the folder, folders:get still attempts to add a d_ prefix and folders:items is probably incorrect.  I’m signed into CLI as our global admin account which owns this content, so it shouldn’t be a permissions problem. If I do a folders:items 0 as the given user, I see the workspace folder and ID.  The code imports a CSV of folders that I’ve pulled already.  I’m still new to the CLI so obviously I’m doing something wrong but I don’t know why it’s adding a d_ prefix to the content. I’ve tried to add a Trim() to the folder ID, but the folder ID shows correct in the text output before the actual dele

Hi,I’m trying to use the python API to download files from a collaborator shared folder. I’m using a free developer account. I made an app and it was authorized (by myself). It was working fine in March 2024 and stopped working when I tried today (Sept 13 2024).```auth = CCGAuth(client_id='xxx',client_secret='xxx',user='xxx')client = Client(auth)user =  client.user().get()"POST https://api.box.com/oauth2/token" 400 77{'date': 'Fri, 13 Sep 2024 17:49:32 GMT', 'content-type': 'application/json', 'strict-transport-security': 'max-age=31536000', 'set-cookie': 'box_visitor_id=66e478e2429fb8.44475236; expires=Sat, 13-Sep-2025 17:49:32 GMT; Max-Age=31536000; path=/; domain=.box.com; secure; SameSite=None, bv=PARTNERS-28114; expires=Fri, 20-Sep-2024 17:49:32 GMT; Max-Age=604800; path=/; domain=.app.box.com; secure, cn=33; expires=Sat, 13-Sep-2025 17:49:32 GMT; Max-Age=31536000; path=/; domain=.app.box.com; secure, site_preference=desktop; path=/; domain=.box.com; secure', 'cache-control': 'no-

As I understand it, the Enterprise plan includes a limit of 100,000 API calls per month. Upon reviewing the Admin Console, I noticed there are "Chargeable" and "Non-Chargeable" API calls. Could you please clarify if "Non-Chargeable" API calls are also counted toward the 100,000 API calls per month limit?

Goal : Try to fetch the retention policy on a file if there is one.When creating the App I enabled manage_data_retention scope and I am sure that there are files under retention policies.Even though File information in UI is giving retention policy information, GET Get file information This APi is not returning any retention policy information  I tried to fetch all the files under retention policies and use query like file_id to narrow down the retention policy on file.GET List file version retentions But the response I am getting is:  { "entries": [], "limit": 100, "order": [ { "by": "file_version_id", "direction": "ASC" } ] } I tried to fetch file_versions under retention policy assignment but that is giving API used : GET Get files under retention {"type": "error","status": 403,"code": "access_denied_insufficient_permissions","help_url": "http://developers.box.com/docs/#errors","message": "Access denied - insufficient permission","request_id": "---"} IN the scopes documentatio

It is possible to make API calls and create custom apps with a free account (Individual), but could you please answer the following questions?What are the API call limitations? What are the differences between free and paid accounts in terms of what can be done with custom apps created?

i have a customer that want me to download his files 100M how can i know my throughput , on how many request per min / per day , is it per client or per application.how can i know the maximum requests i can make per day ?

I have a question regarding rate limiting for license-based APIs. developer.box.com Rate Limits - Box Developer Documentation Explore the Box APIs and SDKs to use for app development, API documentation, developer support resources, and access the Box Developer Console Is the license-based API rate limit after publishing a custom app related to the plan that the party issuing OAuth (i.e., the developer of the custom app) has signed up for, which increases the count when making API calls from the app? Or does the contracted plan of the user of the app affect the API call limit?

I’m using OAuth 2.0 and I have verified that the program is making the API call with the correct folder ID beforehand. This program was working for me yesterday, so nothing has changed on my end. I am just a one admin user business account, so I’m pretty sure I have all the correct permissions. Any help would be amazing, thanks.

By using node sdk , file is uploaded and then after uploading file ,  I would like to get that uploaded file id. File is uploaded successfully response code s200. Althought I try out , I cannot get that uploaded file id. I cannot understand how can I get data from return Promise<Object> data type.Therefore, could you support and find out solution for that issue. My code snippest is as below.  // Initialize the Box SDK              var sdk = new BoxSDK({                clientID: sdkConfig.clientID,                clientSecret: sdkConfig.clientSecret,                appAuth: {                    keyID: sdkConfig.appAuth.keyID,                    privateKey: sdkConfig.appAuth.privateKey,                    passphrase: sdkConfig.appAuth.passphrase                }            });              var appUserClient = sdk.getAppAuthClient('user',userId);              var stream =fs.createReadStream(newPath); // upload file’s path              var parentFolderId = parentFolderId             

I would like to preview content of file when searching, like actual box search screen.can anyone tell me how can I do this? 

Hi!I would know how the throttling/rate limit on a user basis (1000 API calls per minute) is applied when you use a JWT application (service account) to act on behalf of another user by leveraging the as-user header.The limit is applied to...The service account itself Or the impersonated user (as-user)And if I create another service account, the user based limit is reset for this new account (1000 API calls per minute)?

I am working on a PowerShell script to automate archiving files that are 5GB each. I am working directly with the API in PowerShell since BoxCLI does not utilize chunked uploads. When running the “POST Upload Part of a File” command for the final chunk of a file, I am getting an error that the content-range is invalid. The final part of the file is not the same length as the rest of the parts, and the documentation states that is an allowed exception. All initial parts upload without error, and return the expected values for the upload. When I run the final part using a content-range header value of “83886080-95925607/95925607” I get the following error:{ "code": "range_out_of_bounds", "message": "Part with offset 83886080 and size 12039528 exceeds limits of file size 95925607", "request_id": "8642639592d5d19e401d2d252ba83641"}It looks like the API is ignoring the higher bound value provided in the content-range and using the higher bound that would be set if using the full pa

Hello!If anyone has worked or have been working on retrieving the Collaborations Report using Box API in Python and not from the Admin Console? If yes, I’m looking for possibilities to create the report and your knowledge/suggestions would be greatly appreciated!Thank you,Suvidha Vaddula

I have some Python code that has successfully been making API calls for months (to specifically start a Workflow). It suddenly stopped working the week before last. When I went to investigate, the code that gets me an access token has suddenly stopped working, returning the normal error of {'error': 'invalid_grant', 'error_description': 'Grant credentials are invalid'}My question is, is there some kind yearly “account refresh” I need to do? Or is there a backend token I am not aware of that needs a refresh? I did check and my client secret, client id, and service account id are all correct. Here is a simplified version of the code. def get_access_token(client_id_var, client_secret_var, service_account_id): #This URL gets us our access token # Define the URL url = "https://api.box.com/oauth2/token" # Define the request parameters payload = { "client_id": client_id_var, "client_secret": client_secret_var, "grant_type": "client_credentials", "box_subject_type"

Hello!If anyone has worked/ have been working on retrieving the Collaborations Report using Box API in Python and not from the Admin Console, I’m looking for possibilities to create the report and your knowledge/suggestions would be greatly appreciated!Thank you,Suvidha Vaddula

I'm the developer of an online logbook for pilots.  For years, I've had oAuth2 support to allow users to back up their data to Dropbox, Google Drive, and OneDrive.  I'd like to add Box.com as an option.  The technical piece of this is pretty straightforward - but one thing I need is a Box.com logo that I can use in the UI where people set up the oAuth connection.  Dropbox, Onedrive, and Google Drive all grant permission to use - and provide approved logos! - for this legitimate purpose (with conditions, of course!). I can't find anything about how to do this with Box.

For the search interface,  Search for content - API Reference - Box Developer DocumentationI am wondering how to know the folder layers from the response. I see there is a property named Path_Collection, which seems has all folder names, but the sequence_id property is always 0 or null. How can we know which is the direct parent folder, which is the second level? Can we relay on the item sequence of the collection? For example, for below response, can we consider the folder path is All Files/B/A ?  "path_collection": {                "total_count": 4,                "entries": [                    {                        "type": "folder",                        "id": "0",                        "sequence_id": null,                        "etag": null,                        "name": "All Files"                    },                    {                        "type": "folder",                        "id": "230155851619",                        "sequence_id": "0",                       

I have tick all the permissions from App Console but still not able to update collaborator role from co-owner to owner of a user(Member not admin,co-admin) I am using PUT method /collaborations/{collaboration_id}\ 

Can anyone suggest the latest way to  get shared file Download url? I got next js 13  with react 18 project . There is no JS SDK currently so  using CDN v21.0.0. I need to get picked file download url from the file picker window and send it to the Back End to be downloaded there and fetch it then from different endpoint to my project. Thanks.

Hello,I tried to use box webhooks to catch a new collaboration acceptation after having created it with box API. I notice that it works perfectly when the account already exists for this new collaboration on a folder. But if the account doesn't exist, there is no trigger on "COLLABORATION.ACCEPTED".I’m looking for a solution for the webhook to let me know when a user creates his box account and accept the collaboration at the same time.Thanks a lot.Christophe

Hi, I want to set up a webhook or event detection whenever we request signature via Docusign on a Box file.We are using the Docusign integration where you can click into a PDF file, open up the Activity Sidebar, and then click on “Send with Docusign”. I’ve attached a screenshot below displaying how we are currently doing this. Anytime this happens, I would like for a Box Webhook or the Events API to detect this event. 

Hi everyone,I'm seeking assistance with configuring a Box application to retrieve files from a specific folder using their API. I have an admin account on Box.com where the files reside.My goal is to achieve this using Client Credentials Grant authentication. However, when I create a new app in the Developer Console, it requires authorization before I can obtain an access token.Here's the challenge: I want to deploy a script on my WordPress website that automatically downloads a file daily from the Box folder and utilizes it for specific tasks. However, the Developer Console currently identifies me as an admin, not a developer. This restricts my app from accessing the files via API.Previous Attempt:I tried creating a separate developer account and adding it as a collaborator to the main (admin) account. This allowed me to verify and authorize the app, obtaining an access token. However, I'm concerned that a developer account wouldn't grant access to the specific files within the folder

Hello community, Need your help i’m always getting this error when hitting that api

Previously, the Get Box Sign request by ID endpoint at https://api.box.com/2.0/sign_requests/**:sign_request_id** would return a filled in document_tag_id if one existed, as shown at https://developer.box.com/reference/get-sign-requests-id/ e.g. "inputs": [ { "document_tag_id": "1234", "text_value": "text", "checkbox_value": true, "date_value": "2021-04-26", "type": "text", "content_type": "signature", "page_index": 4, "read_only": true } However, now document_tag_id is always null for all inputs on sign requests made June 13th and after. Prior to that (June 12th and before) those requests seem to be functioning correctly still and returning document_tag_id as expected. My assumption would be this is just a bug that was introduced in the API endpoint? Expected behavior: document_tag_id is not null Actual: document_tag_id is null

I’ve integrated box with my dotnet application, I’ve created folder via our application in box and after uploaded few files in the particular folder. After I tried to search that specific file with file name and parent folder id it returning empty result at the time of file uploaded, after few minutes(around 5-10 minutes) later when we try with the same API call, it bring the expected results. Please find the used code in below and suggest or share your thoughts.  Client.SearchManager.QueryAsync(                    fileName,                    ancestorFolderIds: new List<string>() { parentFolderId },                    fields: new[] { "id,name,type,path_collection,size,created_at,modified_at" },                    limit: 30)