Get organization info

GET 
/v2/orgs/:org_id

Retrieves organization information.

Required scope

organizations:read

Rate limiting

Level 3

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

Responses

200

Organization found

application/json

Schema

Schema

id stringrequired

Id of the organization

fullLicensesPurchased int32required

Purchased FULL licenses

name stringrequired

Name of the organization

plan stringrequired

Possible values: [company, consultant, consultant_slf, business, paid_team_org, integration_org, professional_2022, edu_team_org, free_team_org, dev_team_org, unknown]

Organization plan type

type string

Default value: organization

Type of the object returned.

Example (from schema)

{
  "id": "3074457345821140946",
  "fullLicensesPurchased": 0,
  "name": "Miro company",
  "plan": "company",
  "type": "organization"
}

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"
}

409

Conflict

application/json

Schema

Schema

status number

Default value: 409

HTTP status code.

code string

Default value: conflict

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": 409,
  "code": "conflict",
  "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...