Navigate...
Get List
sdk.lists.get(listId)
Retrieve a recipient list by ID. Returns list metadata including totalItems — the current number of recipients. Use this to verify a list before passing it to createDraft().
API key required to run methods
API Key *
Base URL
listId
string
required
List ID
List ID
Returns
RecipientList
List object with metadata and recipient count
id
string
Unique list identifier
projectId
string
Parent project ID
name
string
List display name
notes
string | null
Optional notes
totalItems
number
Number of recipients currently in the list
createdBy
string | null
User who created the list
createdByApiKeyId
string | null
API key used to create the list
createdAt
string
ISO 8601 creation timestamp
updatedAt
string
ISO 8601 last update timestamp
Errors
Invalid list id
The request is not authorized
You do not have permission to access this resource
List not found
See Also
getRecipients()
View the actual recipients in this list
update()
Update list name or notes
createDraft()
Use this list for a distribution
Generated Code