provider Contacts API - Lists GET /contactdb/lists/{list_id}
@utdk/sendgrid /contactdb/lists/{list_id}
Retrieve a single list
**This endpoint allows you to retrieve a single recipient list.**
list_id path required
string
list_id query
The ID of the list to retrieve.
integer
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.

getContactdbListsListId
GET/contactdb/lists/{list_id}
**This endpoint allows you to retrieve a single recipient list.**

Parameters

required

The ID of the list to retrieve.

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.getContactdbListsListId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})