0

Create board export job

by
Published Oct 17, 2025

Creates an export job for one or more boards.Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using this form.

Script miro Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Miro = {
3
  token: string;
4
};
5
/**
6
 * Create board export job
7
 * Creates an export job for one or more boards.Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using this form.
8
 */
9
export async function main(
10
  auth: Miro,
11
  org_id: string,
12
  request_id: string | undefined,
13
  body: { boardIds?: string[]; boardFormat?: "SVG" | "HTML" | "PDF" },
14
) {
15
  const url = new URL(
16
    `https://api.miro.com//v2/orgs/${org_id}/boards/export/jobs`,
17
  );
18
  for (const [k, v] of [["request_id", request_id]]) {
19
    if (v !== undefined && v !== "" && k !== undefined) {
20
      url.searchParams.append(k, v);
21
    }
22
  }
23
  const response = await fetch(url, {
24
    method: "POST",
25
    headers: {
26
      "Content-Type": "application/json",
27
      Authorization: "Bearer " + auth.token,
28
    },
29
    body: JSON.stringify(body),
30
  });
31
  if (!response.ok) {
32
    const text = await response.text();
33
    throw new Error(`${response.status} ${text}`);
34
  }
35
  return await response.json();
36
}
37