Cloud

Organizations REST API / Reference / REST API

Domains

Postman Collection

OpenAPI

Domain APIs

Operations

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

GET

Get domains in an organization

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

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

Responses

Successful operation

application/json

DomainPage

GET/v1/orgs/{orgId}/domains

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "data": [
    {
      "id": "<string>",
      "type": "domains",
      "attributes": {
        "name": "<string>",
        "claim": {
          "type": "http",
          "status": "verified"
        }
      },
      "links": {
        "self": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "prev": "<string>",
    "next": "<string>"
  }
}

GET

Get domain by ID

Returns information about a single verified domain by ID.

Request

Path parameters

orgId

string

Required

domainId

string

Required

Responses

Successful operation

application/json

Domain

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

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains/{domainId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "data": {
    "id": "<string>",
    "type": "domains",
    "attributes": {
      "name": "<string>",
      "claim": {
        "type": "http",
        "status": "verified"
      }
    },
    "links": {
      "self": "<string>"
    }
  }
}