> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivolio.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server.

# List domains

GET /workspaces/domains

Lists the first-party tracking domains registered for the active workspace.

Reference: https://docs.pivolio.com/api-reference/pivolio/domains/list-domains

## Authentication

- `X-Workspace-Id` header (required) — API Key authentication via header

## Response

### 200

Successful Response

- `list of DomainResponse`

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (string, required)
- `code` (string, required)
- `errors` (list of FieldError, optional, nullable)

## Types

### DomainResponse

- `id` (string, required)
- `hostname` (string, required)
- `status` (enum, required) — Lifecycle of a customer first-party tracking domain.
  - Allowed values: `pending`, `verified`, `active`, `error`
- `cname_target` (string, required)
- `last_error` (string, required, nullable)
- `created_at` (datetime, required)
- `verified_at` (datetime, required, nullable)

### FieldError

- `field` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "hostname": "tracking.example.com",
    "status": "active",
    "cname_target": "pivolio-cname.example.net",
    "last_error": null,
    "created_at": "2024-01-15T09:30:00Z",
    "verified_at": "2024-01-20T11:45:00Z"
  },
  {
    "id": "7b9e1d2a-4f3c-4d2a-9f3e-1a2b3c4d5e6f",
    "hostname": "ads.example.org",
    "status": "pending",
    "cname_target": "pivolio-cname.example.org",
    "last_error": "DNS record not found",
    "created_at": "2024-02-10T14:00:00Z",
    "verified_at": null
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.example.com/workspaces/domains"

headers = {"X-Workspace-Id": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/workspaces/domains';
const options = {method: 'GET', headers: {'X-Workspace-Id': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces/domains"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Workspace-Id", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/workspaces/domains")
  .header("X-Workspace-Id", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/workspaces/domains', [
  'headers' => [
    'X-Workspace-Id' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/workspaces/domains");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Workspace-Id", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Workspace-Id": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/workspaces/domains")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```