Get board classification

GET 
/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classification

Retrieves board classification for a board.

Required scope

boards:read

Rate limiting

Level 2

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. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
id of the organization
Example: 3074457345821141000
team_id stringrequired
id of the team
Example: 3074457345618265000
board_id stringrequired
Unique identifier of the board that you want to retrieve.
Example: o9J_kzlUDmo=

Responses

200

Board classification

application/json

Schema

Schema

color string

Label color.

description string

Label description.

id string

Label id.

name string

Label name.

sharingRecommendation string

Sharing Recommendation (one of NO_SHARING_RESTRICTIONS, ONLY_WITHIN_ORGANIZATION, ONLY_WITHIN_TEAM or ONLY_WITH_AUTHORIZED_TEAM_MEMBERS ).

guidelineUrl string

Indicates the URL for the board classification label guidelines.

type string

Default value: board-data-classification-label

Type of the object returned.

Example (from schema)

{
  "color": "blue",
  "description": "Board could not be shared publicly",
  "id": "3000457366756290996",
  "name": "internal",
  "sharingRecommendation": "NO_SHARING_RESTRICTIONS",
  "guidelineUrl": "https://miro.com",
  "type": "board-data-classification-label"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Default value: forbiddenAccess

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Invalid access

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Default value: notFound

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Default value: tooManyRequests

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...