Get board export jobs list

get

https://api.miro.com/v2/orgs/{org_id}/boards/export/jobs

Retrieves the list of board export jobs based on the filters provided in the request.

Required scope

Rate limiting

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

Unique identifier of the organization.

Query Params

status

array of strings

Status of the board export jobs that you want to retrieve, such as JOB_STATUS_CREATED, JOB_STATUS_IN_PROGRESS, JOB_STATUS_CANCELLED or JOB_STATUS_FINISHED.

status

creatorId

array of int64s

Unique identifier of the board export job creator.

creatorId

cursor

uuid

A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request.

limit

int32

1 to 500

Defaults to 50

The maximum number of results to return per call. If the number of jobs in the response is greater than the limit specified, the response returns the cursor parameter with a value.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of board export jobs.

400Malformed request

401Invalid authentication credentials

403Invalid access

404Not found

429Too many requests