provider Domain Authentication GET /whitelabel/domains
@utdk/sendgrid /whitelabel/domains
List all authenticated domains
**This endpoint allows you to retrieve a list of all domains you have authenticated.**
limit query
Number of domains to return.
integer
offset query
Paging offset.
integer
exclude_subusers query
Exclude subuser domains from the result.
boolean
username query
The username associated with an authenticated domain.
string
domain query
Search for authenticated domains.
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getWhitelabelDomains
GET/whitelabel/domains
**This endpoint allows you to retrieve a list of all domains you have authenticated.**

Number of domains to return.

Paging offset.

Exclude subuser domains from the result.

The username associated with an authenticated domain.

Search for authenticated domains.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getWhitelabelDomains({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})