List all authenticated domains · Email Activity (beta)

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)

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."
})