Organizations REST API Developer

Organizations REST API Developer

Download Postman Collection

About the organizations REST API

Use this REST API to get details about organizations including their users and domains.

Authentication and authorization

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.

Version and URI

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>

Pagination

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.

Orgs

Get organizations

GET /admin/v1/orgs

Returns a list of your organizations (based on your API key).

Request

Query parameters
cursor

string

Sets the starting point for the page of results to return.

page[cursor] Deprecated

string

This parameter has been deprecated and will be removed November 1, 2019. Use cursor instead.

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

OrgPage

Get an organization by ID

GET /admin/v1/orgs/{orgId}

Returns information about a single organization by ID

Request

Path parameters
orgId Required

string

ID of the organization to return

Example

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'

Responses

Successful operation

Content typeValue
application/json

Org

Get users in an organization

GET /admin/v1/orgs/{orgId}/users

Returns a list of users in an organization.

Request

Path parameters
orgId Required

string

ID of the organization to query

Query parameters
cursor

string

Sets the starting point for the page of results to return.

page[cursor] Deprecated

string

This parameter has been deprecated and will be removed November 1, 2019. Use cursor instead.

Example

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'

Responses

Successful operation

Content typeValue
application/json

UserPage

Get domains in an organization

GET /admin/v1/orgs/{orgId}/domains

Returns a list of domains in an organization one page at a time.

Request

Path parameters
orgId Required

string

ID of the organization to query

Query parameters
cursor

string

Sets the starting point for the page of results to return.

page[cursor] Deprecated

string

This parameter has been deprecated and will be removed November 1, 2019. Use cursor instead.

Example

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'

Responses

Successful operation

Content typeValue
application/json

DomainPage

Get domain by ID

GET /admin/v1/orgs/{orgId}/domains/{domainId}

Returns information about a single verified domain by ID.

Request

Path parameters
orgId Required

string

ID of the organization the domain belongs to

domainId Required

string

ID of the domain to return

Example

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'

Responses

Successful operation

Content typeValue
application/json

Domain

Get an audit log of events

GET /admin/v1/orgs/{orgId}/events

Returns an audit log of events from an organization one page at a time.

Request

Path parameters
orgId Required

string

ID of the org

Query parameters
cursor

string

Sets the starting point for the page of results to return

q

string

Single query term for searching events.

from

string

The earliest date and time of the event represented as a UNIX epoch time.

to

string

The latest date and time of the event represented as a UNIX epoch time.

action

string

A query filter that returns events of a specific action type.

Example

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'

Responses

Successful operation

Content typeValue
application/json

EventPage