provider Lists GET /marketing/lists/{id}
@utdk/sendgrid /marketing/lists/{id}
Get a List by ID
**This endpoint returns data about a specific list.** Setting the optional parameter `contact_sample=true` returns the `contact_sample` in the response body. Up to fifty of the most recent contacts uploaded or attached to a list will be returned, sorted alphabetically, by email address. The full contact count is also returned.
id path required
string
contact_sample query
Setting this parameter to the true will cause the contact_sample to be returned
boolean

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.

getMcListsId
GET/marketing/lists/{id}
**This endpoint returns data about a specific list.** Setting the optional parameter `contact_sample=true` returns the `contact_sample` in the response body. Up to fifty of the most recent contacts uploaded or attached to a list will be returned, sorted alphabetically, by email address. The full contact count is also returned.

Parameters

required

Setting this parameter to the true will cause the contact_sample to be returned

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.getMcListsId({
  "contact_sample": false
})