List publications

GET

Retrieve all publications associated with your API key.

Query parameters

expandlist of enumsOptional

Optionally expand the results by adding additional information like subscription counts and engagement stats.

limitintegerOptional

A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.

pageintegerOptional

Pagination returns the results in pages. Each page contains the number of results specified by the limit (default: 10).
If not specified, results 1-10 from page 1 will be returned.

direction"asc" or "desc"OptionalDefaults to asc

The direction that the results are sorted in. Defaults to asc
asc - Ascending, sorts from smallest to largest.
desc - Descending, sorts from largest to smallest.

Allowed values: ascdesc
order_by"created" or "name"OptionalDefaults to created

The field that the results are sorted by. Defaults to created
created - The time in which the publication was first created.
name - The name of the publication.

Allowed values: createdname

Response

OK

datalist of objects
limitinteger

The limit placed on the results. If no limit was specified in the request,this defaults to 10.

pageinteger>=0

The page number the results are from. If no page was specified in the request, this defaults to page 1.

total_resultsinteger

The total number of results from all pages.

total_pagesinteger

The total number of pages.

Errors

Built with