Get listing of lists

Get a list of all lists, or a list of lists of a specified type. You can get a list from most Act-On listing types (see the table below).


Name Parameter
Data Type Description
Authorization: Header False Required String (Bearer {access token}) Pass the authentication token that was granted when you authorized access.
listingtype Query false Optional String Possible Values:

CONTACT_LIST (Default value)
count Query false Optional String Number of elements to download. (Default=1000, maximum=1000)
offset Query False Optional String element at which the fetch begins. Default=0

The JSON response will include objects that have sourceId, baseId and id parameters.

sourceId is the real canonical ID for a given object in the API response.

  • sourceId will begin with either “l-” “q-” or “g-“
  • If the sourceId begins with “l-” it means it is a list and records can be added to it via the API
  • If the sourceId begins with “q-” it is a logically defined segment of a list and records cannot be added to it via the API
  • If the sourceId begins with “g-” it is an explicitly defined segment of a list and records cannot be added to it via the API

baseId and id are functionally equivalent. The baseId and id will reflect They will only differ from the sourceId if the sourceId starts with “q-” or “g-” and will represent the base list that the segment is built on.



Following is an example HTTP request:



A successful request results in an HTTP 200 response with a JSON object that contains the list listing.

An example JSON response from the above JSON request:

If the “sourceID” and “baseID” are different then the list is a Segment.

For Segments the “sourceID” is the SegmentID, “sourceName” is the segment name, and “description” indicates the source of the segment. Possible values for “description” include “Explicitly Selected Group” (corresponds to “Direct Selection” in the UI), “Saved Search Result” (corresponds to “Search” in the UI), and “Segment” (corresponds to “Query” in the UI).

Code Examples

Grant Type Password
Grant Type Code
Grant Type Refresh
Account API
Get account information
Create new account user
Delete account users
Delete account user
Get email senders
Fact API
Upload custom events
Get upload custom event status
List API
Get listing of lists
Download a list
Create a new list
Update or merge a list
Get list upload status
Get rejected records from an upload
Delete a list
Delete records from a list
Get hard bounce list
Get spam complaint list
Get Opt-Out List
Update Out-Out List
Get Subscription Opt-Outs by Category
Content API
Get Logo List
Get a logo
Add a logo
Update a logo
Delete a logo
Get header list
Get a header
Add a header
Update a header
Delete a header
Get footer list
Get a footer
Add a new footer
Delete a footer
Update a footer
Get image list
Get an image
Add an image
Replace an image
Delete an image
Get media list
Get media file
Add a media file
Add a media link
Update Media File
Delete a media object
Get form list
Get promotional form URLs
Get page list
Get page
Delete page
Get promotional page URLs
Get list of programs
Reporting API
Get message report
Get message report drilldown
Get message report by time period
Get media report
Get media message report
Get a media view report
Get a media timeline report
Get form report
Get page report
Get spam complaint list
Get hard bounce list
Email Campaign API
Get message list
Send a message
Resend a message
Add new template or draft message
Update template or draft message
Delete a message
Get message report
Get message report drilldown
Get message report by time period
Get message HTML contents
Contact API
Add a contact
Get contact record
Upsert a contact record by email
Update a contact by record ID
Delete a contact
Get contact record ID based on cookie value
Get contact from list based on cookie ID or e-mail
Get contact fact and score data
Get subscription categories
Opt in/Opt out subscription category by email address
Get subscription category opt-ins by email
Opt in/Opt out multiple subscription categories by email address
Get SEO keywords
Get a new SEO report
Frequently Asked Questions