Return All Organizations

GET /api/atlas/v2/orgs

Copy endpoint

https://cloud.mongodb.com

Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

Parameters

query Query Parameters

Name	Type
`envelope` Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.	boolean
`includeCount` Flag that indicates whether the response returns the total number of items (totalCount) in the response.	boolean
`itemsPerPage` Number of items that the response returns per page.	number
`pageNum` Number of the page that displays the current set of the total objects that the response returns.	number
`pretty` Flag that indicates whether the response body should be in the prettyprint format.	boolean
`name` Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.	string

Responses

200 application/vnd.atlas.2023-01-01+json

interface PaginatedOrganizationView {
links?: readonly

Link

interface Link {
href?: string;
rel?: string;
}

[];
results?: readonly

AtlasOrganization

Details that describe the organization.

interface AtlasOrganization {
id?: string;
isDeleted?: boolean;
links?: readonly Link[];
name: string;
skipDefaultAlertsSettings?: boolean;
}

[];
totalCount?: number;
}

Client Errors

400 application/json

Bad Request.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

403 application/json

Forbidden.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

404 application/json

Not Found.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

409 application/json

Conflict.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}