Skip to main content
Question

API to get a list of annotations

  • May 22, 2025
  • 3 replies
  • 59 views
C
Forum|alt.badge.img

Hello.

I would like to use API to get a list of annotations for a file.

Is there such  API available?

If not, could you please implement such an API?

For example, something like this.

(e.g.) https://api.box.com/2.0/files/:file_id/annotations/

    3 replies

    C
    Forum|alt.badge.img

    Hi! 

    Thanks for the suggestion. We don't currently have an API for this. I would upvote the post about this on Pulse. 

    Thanks, 

    Alex, Box Developer Advocate

    C
    Forum|alt.badge.img

    api.box.com/2.0/undoc/annotations?file_id={file_id}&marker=&limit=1000

    C
    Forum|alt.badge.img

    While I was searching for an API to retrieve annotations, I discovered that the following API is used on the screen to retrieve them:  
    I assume this is an unofficial API, but on the other hand, my client has requested the ability to retrieve annotations via API, so I was considering using this approach.  
    I understand that using this API would likely be outside the scope of official support, but if there is any official stance or guidance regarding its use, I would appreciate your comments.

    https://api.box.com/2.0/undoc/annotations?file_id=xxxxx&marker&limit=100

    Terms of ServiceAccessibility statement