# List All the Authenticated Domains Associated with a Subuser

## API Overview

An authenticated domain allows you to remove the "via" or "sent on behalf of" message that your recipients see when they read your emails. Authenticating a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will get 2 TXT records and 1 MX record.

Domain Authentication was formerly called "Domain Whitelabel".

For more information, please see [How to set up domain authentication](/docs/sendgrid/ui/account-and-settings/how-to-set-up-domain-authentication/).

> \[!NOTE]
>
> Each user may have a maximum of 3,000 authenticated domains and 3,000 link brandings. This limit is at the user level, meaning each Subuser belonging to a parent account may have its own 3,000 authenticated domains and 3,000 link brandings.

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/whitelabel/domains/subuser/all","method":"get","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]}
```

**This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.**

This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account, and a subuser can have up to five associated domains.

To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools.

When selecting a domain to send email from, SendGrid checks for domains in the following order and chooses the first one that appears in the hierarchy:

1. Domain assigned by the subuser that matches the email's `From` address domain.
2. The subuser's default domain.
3. Domain assigned by the parent user that matches the `From` address domain.
4. Parent user's default domain.
5. sendgrid.net

## Operation details

### Authentication

API Key

### Headers

```json
[{"in":"header","name":"Authorization","required":true,"default":"Bearer <<YOUR_API_KEY_HERE>>","schema":{"type":"string"}}]
```

### Query string

```json
[{"name":"username","in":"query","description":"Username for the subuser to find associated authenticated domains.","required":true,"schema":{"type":"string"}}]
```

### Responses

```json
[{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["automatic_security","custom_spf","default","dns","domain","id","ips","legacy","subdomain","user_id","username","valid"],"properties":{"id":{"type":"number","description":"The ID of the authenticated domain."},"user_id":{"type":"number","description":"The ID of the user that this domain is associated with."},"subdomain":{"type":"string","description":"The subdomain or custom return-path to use for this authenticated domain."},"domain":{"type":"string","description":"The domain to be authenticated."},"username":{"type":"string","description":"The username that this domain will be associated with."},"ips":{"type":"array","description":"The IPs to be included in the custom SPF record for this authenticated domain.","items":{"type":"string"}},"custom_spf":{"type":"boolean","description":"Indicates whether this authenticated domain uses custom SPF."},"default":{"type":"boolean","description":"Indicates if this is the default authenticated domain."},"legacy":{"type":"boolean","description":"Indicates if this authenticated domain was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create a new authenticated domain if you need to update it."},"automatic_security":{"type":"boolean","description":"Indicates if this authenticated domain uses automated security."},"valid":{"type":"boolean","description":"Indicates if this is a valid authenticated domain."},"dns":{"type":"object","description":"The DNS records used to authenticate the sending domain.","required":["mail_cname","dkim1","dkim2"],"properties":{"mail_cname":{"type":"object","description":"The CNAME for your sending domain that points to sendgrid.net.","required":["valid","type","host","data"],"properties":{"valid":{"type":"boolean","description":"Indicates if this is a valid CNAME."},"type":{"type":"string","description":"The type of DNS record."},"host":{"type":"string","description":"The domain that this CNAME is created for.","format":"hostname"},"data":{"type":"string","description":"The CNAME record."}}},"dkim1":{"type":"object","description":"A DNS record.","required":["valid","type","host","data"],"properties":{"valid":{"type":"boolean","description":"Indicates if this is a valid DNS record."},"type":{"type":"string","description":"The type of DNS record."},"host":{"type":"string","description":"The domain that this DNS record was created for."},"data":{"type":"string","description":"The DNS record."}}},"dkim2":{"type":"object","description":"A DNS record.","required":["valid","type","host","data"],"properties":{"valid":{"type":"boolean","description":"Indicates if this is a valid DNS record."},"type":{"type":"string","description":"The type of DNS record."},"host":{"type":"string","description":"The domain that this DNS record was created for."},"data":{"type":"string","description":"The DNS record."}}}}}}}},"examples":{"response":{"value":[{"id":1,"domain":"example.com","subdomain":"mail","username":"jdoe","user_id":7,"ips":[],"custom_spf":true,"default":false,"legacy":false,"automatic_security":false,"valid":false,"dns":{"mail_cname":{"valid":true,"type":"cname","host":"mail.example.com","data":"u7.wl.sendgrid.net"},"dkim1":{"valid":true,"type":"cname","host":"s1._domainkey.example.com","data":"s1._domainkey.u7.wl.sendgrid.net"},"dkim2":{"valid":true,"type":"cname","host":"s2._domainkey.example.com","data":"s2._domainkey.u7.wl.sendgrid.net"}}},{"id":2,"domain":"example.com","subdomain":"mail2","username":"jdoe2","user_id":7,"ips":[],"custom_spf":true,"default":true,"legacy":false,"automatic_security":true,"valid":false,"dns":{"mail_cname":{"valid":true,"type":"cname","host":"mail2.example2.com","data":"u7.sgsandbox.net"},"dkim1":{"host":"s1._domainkey.example.com","type":"cname","data":"s1._domainkey.u7.wl.sgsandbox.net","valid":true},"dkim2":{"valid":true,"type":"cname","host":"s2._domainkey.example2.com","data":"s2._domainkey.u7.w1.sgsandbox.net"}}}]}}}}}}]
```

List the authenticated domains associated with the subuser

```js
const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const queryParams = { username: "username" };

const request = {
  url: `/v3/whitelabel/domains/subuser/all`,
  method: "GET",
  qs: queryParams,
};

client
  .request(request)
  .then(([response, body]) => {
    console.log(response.statusCode);
    console.log(response.body);
  })
  .catch((error) => {
    console.error(error);
  });
```

```python
import os
from sendgrid import SendGridAPIClient


sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY"))

params = {"username": "username"}

response = sg.client.whitelabel.domains.subuser.all.get(query_params=params)

print(response.status_code)
print(response.body)
print(response.headers)
```

```csharp
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SendGrid;

public class Program {
    public static async Task Main() {
        string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
        var client = new SendGridClient(apiKey);

        var queryParams = @"{'username': 'username'}";

        var response = await client.RequestAsync(
            method: SendGridClient.Method.GET,
            urlPath: "whitelabel/domains/subuser/all",
            queryParams: queryParams);

        Console.WriteLine(response.StatusCode);
        Console.WriteLine(response.Body.ReadAsStringAsync().Result);
        Console.WriteLine(response.Headers.ToString());
    }
}
```

```java
import com.sendgrid.*;
import java.io.IOException;

public class Example {
    public static void main(String[] args) throws IOException {
        try {
            SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
            Request request = new Request();
            request.setMethod(Method.GET);
            request.setEndpoint("/whitelabel/domains/subuser/all");
            request.addQueryParam("username", "username");
            Response response = sg.api(request);
            System.out.println(response.getStatusCode());
            System.out.println(response.getBody());
            System.out.println(response.getHeaders());
        } catch (IOException ex) {
            throw ex;
        }
    }
}
```

```go
package main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"os"
)

func main() {
	apiKey := os.Getenv("SENDGRID_API_KEY")
	host := "https://api.sendgrid.com"
	request := sendgrid.GetRequest(apiKey, "/v3/whitelabel/domains/subuser/all", host)
	request.Method = "GET"
	queryParams := make(map[string]string)
	queryParams["username"] = "username"
	request.QueryParams = queryParams
	response, err := sendgrid.API(request)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}
```

```php
<?php
// Uncomment the next line if you're using a dependency loader (such as Composer) (recommended)
// require 'vendor/autoload.php';

// Uncomment next line if you're not using a dependency loader (such as Composer)
// require_once '<PATH TO>/sendgrid-php.php';

$apiKey = getenv("SENDGRID_API_KEY");
$sg = new \SendGrid($apiKey);
$query_params = json_decode('{
    "username": "username"
}');

try {
    $response = $sg->client
        ->whitelabel()
        ->domains()
        ->subuser()
        ->all()
        ->get(null, $query_params);
    print $response->statusCode() . "\n";
    print_r($response->headers());
    print $response->body() . "\n";
} catch (Exception $ex) {
    echo "Caught exception: " . $ex->getMessage();
}
```

```ruby
require 'sendgrid-ruby'
include SendGrid

sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
params = JSON.parse('{
  "username": "username"
}')

response = sg.client.whitelabel.domains.subuser.all.get(query_params: params)
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -G -X GET "https://api.sendgrid.com/v3/whitelabel/domains/subuser/all?username=username" \
--header "Authorization: Bearer $SENDGRID_API_KEY"
```