Get Organization
Last modified: 11 March 2025
Request
GET <REST API URL>/organizations/{organization id}?fields=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Organization. Use Fields Syntax to define the subset. |
Response
Response Code | Meaning |
|---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"id": string,
"aliases": [alias, ...],
"key": string,
"name": string,
"description": string,
"emailDomain": string,
"creationTime": calendar,
"projects": [project, ...],
"ownUsers": [user, ...],
"users": [user, ...],
"allUsers": boolean,
"groups": [userGroup, ...],
"teams": [projectTeam, ...],
"projectsCount": int,
"iconUrl": string,
"icon": string,
"defaultIcon": boolean,
"organizationRoles": [organizationRole, ...]
}