Rate this page:
Use this REST API to get details about organizations including their users and domains.
To use the organizations REST API you must have a valid API key. The API key protects the API and ensures that you have permission to update and disable the accounts owned by your organization. You can use the same API key for the organizations REST API and the user management REST API. For more information, see Create an API key.
Once you have your API key, you can provide it as a bearer token
in the Authorization part of your HTTPS header.
This documentation is for version 1 of the organizations REST API. The URIs for resources have the following structure:
1
https://api.atlassian.com/admin/v1/orgs/<resource-name>The organizations REST API uses pagination to conserve server resources and limit response size. If there are more results available after the current page, a link to the next page of results is included in the JSON. You can use the cursor parameter to set a specific starting point for the results.
GET /admin/v1/orgs
Returns a list of your organizations (based on your API key).
string
Sets the starting point for the page of results to return.
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}
Returns information about a single organization by ID
string
ID of the organization to return
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}/users
Returns a list of users in an organization.
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}/domains
Returns a list of domains in an organization one page at a time.
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}/domains/{domainId}
Returns information about a single verified domain by ID.
string
ID of the organization the domain belongs to
string
ID of the domain to return
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains/{domainId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}/events
Returns an audit log of events from an organization one page at a time.
string
ID of the org
string
Sets the starting point for the page of results to return
string
Single query term for searching events.
string
The earliest date and time of the event represented as a UNIX epoch time.
string
The latest date and time of the event represented as a UNIX epoch time.
string
A query filter that returns events of a specific action type.
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
GET /admin/v1/orgs/{orgId}/events/{eventId}
Returns information about a single event by ID.
string
ID of the organization to query
string
ID of the event to return
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events/{eventId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Successful operation
| Content type | Value |
|---|---|
| application/json |
Rate this page: