Skip to main content
Answered

REST API Token enterprise vs free plan

  • October 25, 2024
  • 4 replies
  • 120 views

Forum|alt.badge.img+2

Hi
My app will use enterprise API
I wonder how should I refer to particular team in my requests if my app will be installed for whole organization. For example I would like to list boards of each team.

Can I use team id’s listed with GET /teams to dynamically change the team I need to refer to?

Best answer by William Bishop

Hey @liquidus,

Good question! Happy to shine some light on this for you.

To that end, if your app will be installed on an organization level, you can retrieve boards for a specific team by following this flow:
1. Call LIST Teams API to retrieve team_id
2. Next, call GET Boards API and pass the query param team_id with the value from step 1

Essentially, you should be able to loop through GET Teams API to get the team ID, and then pass that to your subsequent requests to get boards, as a query parameter. 

Let me know if it helps!
Will

4 replies

William Bishop
Mironeer
Forum|alt.badge.img+4
  • Mironeer
  • 248 replies
  • Answer
  • October 25, 2024

Hey @liquidus,

Good question! Happy to shine some light on this for you.

To that end, if your app will be installed on an organization level, you can retrieve boards for a specific team by following this flow:
1. Call LIST Teams API to retrieve team_id
2. Next, call GET Boards API and pass the query param team_id with the value from step 1

Essentially, you should be able to loop through GET Teams API to get the team ID, and then pass that to your subsequent requests to get boards, as a query parameter. 

Let me know if it helps!
Will


Forum|alt.badge.img+2
  • Author
  • Beginner
  • 5 replies
  • October 28, 2024

Thank you @William Bishop 

  1. For other requests such as GET sticky notes I will not use team_id as I need to refer to specific board, right?
  2. I assume that query parameter team_id will let me access only teams in which my app was installed, is that right? Can I list boards of team without installed app (I would know team_id).
  3. What is the logic for two above questions for free plan?

Forum|alt.badge.img+2
  • Author
  • Beginner
  • 5 replies
  • October 28, 2024

Related question: which team_id I will receive in access token response if my app will be claimed for whole organization (with enterprise plan)? 
https://developers.miro.com/reference/exchange-authorization-code-with-access-token


Horea Porutiu
Mironeer
Forum|alt.badge.img+1
  • Mironeer
  • 200 replies
  • October 29, 2024
  1. For other requests such as GET sticky notes I will not use team_id as I need to refer to specific board, right?
    Yes. 
  2. I assume that query parameter team_id will let me access only teams in which my app was installed, is that right? Can I list boards of team without installed app (I would know team_id).
    That’s right, you should only have access to teams that your app has been installed on.