AWeber Lists API
The Lists API from AWeber — 4 operations for listing and finding the email lists on an account and reading the tags applied on a list.
OpenAPI Specification
openapi: 3.0.2
info:
title: AWeber Lists API
version: '1.0'
description: 'We are constantly working to improve this documentation. If you have
feedback and questions, please contact the AWeber API team at
api@aweber.com.
The AWeber API is a REST API that uses the OAuth 2.0 authentication model. We also offer webhooks.
Please see the below resources for further information:
- <a href="https://labs.aweber.com/docs/tos" target="_blank">Terms of Service</a>
- <a href="https://help.aweber.com/hc/en-us/articles/204031776" target="_blank">Showcasing an Integration</a>
- <a href="https://help.aweber.com/hc/en-us/sections/360000617213-API" target="_blank">Knowledge Base</a>
- <a href="https://status.aweber.com" target="_blank">API Status Page</a>
'
contact:
name: AWeber API Team
email: api@aweber.com
url: https://api.aweber.com/
servers:
- url: https://api.aweber.com/1.0
description: v1 API endpoints
tags:
- name: Lists
description: '### What is it?
Represents the individual subscriber lists within the AWeber Customer Account.
Use this set of resources to retrieve the available lists and information about each list. The
list collection response is sorted by the generated list `id` and paginated using `next_collection_link`
and `prev_collection_link` properties. See [How Collections are Represented](#collection-representation)
for details on collection traversal.
### Related endpoints
* [Lists](#tag/Lists)
* [Get custom fields for a list](#tag/Custom-Fields/paths/~1accounts~1{accountId}~1lists~1{listId}~1custom_fields/get)
* [Add a custom field to a list](#tag/Custom-Fields/paths/~1accounts~1{accountId}~1lists~1{listId}~1custom_fields/post)
* [Update a custom field on a list](#tag/Custom-Fields/paths/~1accounts~1{accountId}~1lists~1{listId}~1custom_fields~1{customFieldId}/patch)
* [Remove a custom field from a list](#tag/Custom-Fields/paths/~1accounts~1{accountId}~1lists~1{listId}~1custom_fields~1{customFieldId}/delete)
* [Get subscribers on a list](#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/get)
* [Add a subscriber to a list](#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/post)
* [Find subscribers on a list](#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers?ws.op=find/get)
* [Get broadcasts on a list](#tag/Broadcasts/paths/~1accounts~1{accountId}~1lists~1{listId}~1broadcasts/get)
### Related code examples
* [Find a List and Get Tags](#tag/Find-a-List-and-Get-Tags)
* [Manage a Subscriber on a List](#tag/Manage-a-Subscriber)
* [Find Subscribers Across Lists](#tag/Find-Subscribers-Across-Lists)
* [Move Subscriber to Another List](#tag/Move-Subscriber-to-Another-List)
* [Get Webforms for a list](#tag/Get-Webforms-Detail)
'
security:
- OAuth 2.0: []
paths:
/accounts/{accountId}/lists:
get:
summary: Get lists
description: "This endpoint is used to get a paginated collection of subscriber lists.\n\nCheck\
\ out related examples:\n\n * Get Tags (\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/python/get-tags\"\
\ target=\"_blank\">Python</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/php/get-tags\"\
\ target=\"_blank\">PHP</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/postman/Get%20Tags.postman_collection.json\"\
\ target=\"_blank\">Postman</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/csharp/AWeber.Examples.GetTags/\"\
\ target=\"_blank\">C#.NET</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/ruby/get_tags.rb\"\
\ target=\"_blank\">Ruby</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/node/get-tags.js\"\
\ target=\"_blank\">Node.js</a> )"
tags:
- Lists
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/wsStart'
- $ref: '#/components/parameters/wsSize'
security:
- OAuth 2.0:
- list.read
x-code-samples:
- lang: Shell
source: "curl -G \\\n https://api.aweber.com/1.0/accounts/{accountId}/lists \\\n -H 'Authorization:\
\ Bearer {YOUR_ACCESS_TOKEN}'\n"
- lang: Python
source: "headers = {'Accept': 'application/json',\n 'User-Agent': 'AWeber-Python-code-sample/1.0',\n\
\ 'Authorization': f'Bearer {access_token}'}\nurl = f'https://api.aweber.com/1.0/accounts/{account_id}/lists'\n\
response = requests.get(url, headers=headers)\nprint(response.json())\n"
- lang: PHP
source: "$headers = [\n 'User-Agent' => 'AWeber-PHP-code-sample/1.0',\n 'Accept' => 'application/json',\n\
\ 'Authorization' => 'Bearer $token',\n];\n$url = \"https://api.aweber.com/1.0/accounts/{$accountId}/lists\"\
;\n$response = $client->get($url, ['headers' => $headers]);\n$body = json_decode($response->getBody(),\
\ true);\nprint_r($body);\n"
- lang: C#
source: 'const string url = "https://api.aweber.com/1.0/accounts/{accountId}/lists";
var request = new HttpRequestMessage(HttpMethod.Get, url);
request.Headers.Add("Accept","application/json");
request.Headers.Add("User-Agent","AWeber-CSharp-code-sample/1.0");
request.Headers.Add("Authorization", $"Bearer {Token}");
var response = await Client.SendAsync(request);
Console.Write(response.Content.ReadAsStringAsync());
'
- lang: JavaScript
label: Node.js
source: "const headers = {\n \"Accept\": \"application/json\",\n \"User-Agent\": \"AWeber-Node-code-sample/1.0\"\
,\n \"Authorization\": `Bearer ${accessToken}`\n};\nconst url = `https://api.aweber.com/1.0/accounts/${accountId}/lists/`;\n\
fetch(url, { headers: headers })\n .then(response => response.json())\n .then(data => {\n\
\ console.log(data)\n})\n"
- lang: Ruby
source: "headers = {\n 'Accept': 'application/json',\n 'User-Agent': 'AWeber-Ruby-code-sample/1.0',\n\
\ 'Authorization': \"Bearer #{access_token}\"\n}\nresponse = Faraday.get(\n \"https://api.aweber.com/1.0/accounts/#{account_id}/lists\"\
,\n) do |req|\n req.headers = headers\nend\nputs response.body\n"
responses:
'200':
description: The request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Lists'
'400':
description: The server cannot or will not process the request due to a client error
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
One of the following errors may be received:
| Error Type | Explanation |
|----------------------|------------------------------------------|
| WebServiceError | `ws.start` or `ws.size` values are invalid |
| BadRequestError | `ws.op` is invalid (parameter can only be `find`) or there
was an error decoding query parameters | |
| MissingOAuthParametersError | An OAuth parameter is missing in the request |
| UnsupportedOAuthVersionError | Unsupported OAuth 1 version |
| UnsupportedOAuthSignatureMethodError | Unsupported OAuth 1 signature method |
Please see the message body for more details.
'
type: object
properties:
documentation_url:
description: A link to the documentation that describes the error
type: string
example: https://api.aweber.com#badrequest
message:
description: A human friendly description of the error
type: string
example: Maximum for "ws.size" parameter is 100.
status:
description: The HTTP status code
type: integer
example: 400
type:
description: The API error type
type: string
example: WebServiceError
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/BlockedError'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
operationId: getLists
/accounts/{accountId}/lists/{listId}:
get:
summary: Get list
description: "This endpoint is used to retrieve the information for a specific subscriber list.\n\
\nCheck out related examples:\n\n * Get Tags (\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/python/get-tags\"\
\ target=\"_blank\">Python</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/php/get-tags\"\
\ target=\"_blank\">PHP</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/postman/Get%20Tags.postman_collection.json\"\
\ target=\"_blank\">Postman</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/csharp/AWeber.Examples.GetTags/\"\
\ target=\"_blank\">C#.NET</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/ruby/get_tags.rb\"\
\ target=\"_blank\">Ruby</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/node/get-tags.js\"\
\ target=\"_blank\">Node.js</a> )"
tags:
- Lists
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/listId'
security:
- OAuth 2.0:
- list.read
x-code-samples:
- lang: Shell
source: "curl -G \\\n https://api.aweber.com/1.0/accounts/{accountId}/lists/{listId} \\\n -H\
\ 'Authorization: Bearer {YOUR_ACCESS_TOKEN}'\n"
- lang: Python
source: "headers = {'Accept': 'application/json',\n 'User-Agent': 'AWeber-Python-code-sample/1.0',\n\
\ 'Authorization': f'Bearer {access_token}'}\nurl = f'https://api.aweber.com/1.0/accounts/{account_id}/lists/{list_id}'\n\
response = requests.get(url, headers=headers)\nprint(response.json())\n"
- lang: PHP
source: "$headers = [\n 'User-Agent' => 'AWeber-PHP-code-sample/1.0',\n 'Accept' => 'application/json',\n\
\ 'Authorization' => 'Bearer $token',\n];\n$url = \"https://api.aweber.com/1.0/accounts/{$accountId}/lists/{$listId}\"\
;\n$response = $client->get($url, ['headers' => $headers]);\n$body = json_decode($response->getBody(),\
\ true);\nprint_r($body);\n"
- lang: C#
source: 'const string url = "https://api.aweber.com/1.0/accounts/{accountId}/lists/{listId}";
var request = new HttpRequestMessage(HttpMethod.Get, url);
request.Headers.Add("Accept","application/json");
request.Headers.Add("User-Agent","AWeber-CSharp-code-sample/1.0");
request.Headers.Add("Authorization", $"Bearer {Token}");
var response = await Client.SendAsync(request);
Console.Write(response.Content.ReadAsStringAsync());
'
- lang: JavaScript
label: Node.js
source: "const headers = {\n \"Accept\": \"application/json\",\n \"User-Agent\": \"AWeber-Node-code-sample/1.0\"\
,\n \"Authorization\": `Bearer ${accessToken}`\n};\nconst url = `https://api.aweber.com/1.0/accounts/${accountId}/lists/${listId}`;\n\
fetch(url, { headers: headers })\n .then(response => response.json())\n .then(data => {\n\
\ console.log(data)\n})\n"
- lang: Ruby
source: "headers = {\n 'Accept': 'application/json',\n 'User-Agent': 'AWeber-Ruby-code-sample/1.0',\n\
\ 'Authorization': \"Bearer #{access_token}\"\n}\nresponse = Faraday.get(\n \"https://api.aweber.com/1.0/accounts/#{account_id}/lists/#{list_id}\"\
,\n) do |req|\n req.headers = headers\nend\nputs response.body\n"
responses:
'200':
description: The request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/List'
'400':
$ref: '#/components/responses/BadOAuth1'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/BlockedError'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
operationId: getList
/accounts/{accountId}/lists?ws.op=find:
get:
summary: Find lists
description: "This endpoint is used to search for lists when you do not have a link nor know the\
\ list ID.\n\nCheck out related examples:\n\n * Get Tags (\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/python/get-tags\"\
\ target=\"_blank\">Python</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/php/get-tags\"\
\ target=\"_blank\">PHP</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/postman/Get%20Tags.postman_collection.json\"\
\ target=\"_blank\">Postman</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/csharp/AWeber.Examples.GetTags/\"\
\ target=\"_blank\">C#.NET</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/ruby/get_tags.rb\"\
\ target=\"_blank\">Ruby</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/node/get-tags.js\"\
\ target=\"_blank\">Node.js</a> )"
tags:
- Lists
parameters:
- $ref: '#/components/parameters/accountId'
- name: ws.op
in: query
required: true
description: The method name - expecting "find"
schema:
type: string
enum:
- find
- name: name
in: query
required: false
description: Name or unique list ID of the list
schema:
type: string
minLength: 1
maxLength: 100
- $ref: '#/components/parameters/wsStart'
- $ref: '#/components/parameters/wsSize'
- $ref: '#/components/parameters/wsShow'
security:
- OAuth 2.0:
- list.read
x-code-samples:
- lang: Shell
source: "curl -G \\\n https://api.aweber.com/1.0/accounts/{accountId}/lists \\\n -d ws.op=find\
\ \\\n --data-urlencode \"name=Weekly Newsletter\" \\\n -H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}'\n"
- lang: Python
source: "headers = {'Accept': 'application/json',\n 'User-Agent': 'AWeber-Python-code-sample/1.0',\n\
\ 'Authorization': f'Bearer {access_token}'}\nurl = f'https://api.aweber.com/1.0/accounts/{account_id}/lists'\n\
params = urlencode({'ws.op': 'find', 'name': 'Weekly Newsletter'})\nfind_url = '{}?{}'.format(url,\
\ params)\nresponse = requests.get(find_url, headers=headers)\nprint(response.json())\n"
- lang: PHP
source: "$headers = [\n 'User-Agent' => 'AWeber-PHP-code-sample/1.0',\n 'Accept' => 'application/json',\n\
\ 'Authorization' => 'Bearer $token',\n];\n$url = \"https://api.aweber.com/1.0/accounts/{$accountId}/lists\"\
;\n$params = ['ws.op' => 'find', 'name' => 'Weekly Newsletter'];\n$findUrl = $url . '?' . http_build_query($params);\n\
$response = $client->get($findUrl, ['headers' => $headers]);\n$body = json_decode($response->getBody(),\
\ true);\nprint_r($body);\n"
- lang: C#
source: "const string url = \"https://api.aweber.com/1.0/accounts/{accountId}/lists\";\nvar queryParams\
\ = new Dictionary<string, string>\n{\n {\"ws.op\", \"find\"},\n {\"name\", \"Weekly Newsletter\"\
}\n};\nvar encodedQueryParams = string.Join(\"&\", queryParams.Select(\n kvp => string.Format(\"\
{0}={1}\", kvp.Key, Uri.EscapeDataString(kvp.Value))));\nvar getUrl = string.Format(\"{0}?{1}\"\
, url, encodedQueryParams);\nvar request = new HttpRequestMessage(HttpMethod.Get, getUrl);\n\
request.Headers.Add(\"Accept\",\"application/json\");\nrequest.Headers.Add(\"User-Agent\",\"\
AWeber-CSharp-code-sample/1.0\");\nrequest.Headers.Add(\"Authorization\", $\"Bearer {Token}\"\
);\nvar response = await Client.SendAsync(request);\nConsole.Write(response.Content.ReadAsStringAsync());\n"
- lang: JavaScript
label: Node.js
source: "const headers = {\n \"Accept\": \"application/json\",\n \"User-Agent\": \"AWeber-Node-code-sample/1.0\"\
,\n \"Authorization\": `Bearer ${accessToken}`\n};\nquerystring = require(\"querystring\");\n\
const params = querystring.stringify({\n 'ws.op': 'find',\n 'name': 'Weekly Newsletter'\n\
});\nconst url = `https://api.aweber.com/1.0/accounts/${accountId}/lists?${params}`;\nfetch(url,\
\ { headers: headers })\n .then(response => response.json())\n .then(data => {\n console.log(data)\n\
})\n"
- lang: Ruby
source: "headers = {\n 'Accept': 'application/json',\n 'User-Agent': 'AWeber-Ruby-code-sample/1.0',\n\
\ 'Authorization': \"Bearer #{access_token}\"\n}\nparams = {\n 'ws.op': 'find',\n 'name':\
\ 'Weekly Newsletter'\n}\nresponse = Faraday.get(\n \"https://api.aweber.com/1.0/accounts/#{account_id}/lists\"\
,\n params\n) do |req|\n req.headers = headers\nend\nputs response.body\n"
responses:
'200':
description: The request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/FindLists'
'400':
description: The server cannot or will not process the request due to a client error
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
One of the following errors may be received:
| Error Type | Explanation |
|----------------------|------------------------------------------|
| WebServiceError | `ws.start` or `ws.size` values are invalid |
| BadRequestError | `ws.op` is invalid (parameter can only be `find`) or there
was an error decoding query parameters |
| MissingOAuthParametersError | An OAuth parameter is missing in the request |
| UnsupportedOAuthVersionError | Unsupported OAuth 1 version |
| UnsupportedOAuthSignatureMethodError | Unsupported OAuth 1 signature method |
Please see the message body for more details.
'
type: object
properties:
documentation_url:
description: A link to the documentation that describes the error
type: string
example: https://api.aweber.com#badrequest
message:
description: A human friendly description of the error
type: string
example: Maximum for "ws.size" parameter is 100.
status:
description: The HTTP status code
type: integer
example: 400
type:
description: The API error type
type: string
example: WebServiceError
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/BlockedError'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
operationId: findLists
/accounts/{accountId}/lists/{listId}/tags:
get:
summary: Get tags for list
description: "Get the most popular tags for a list. This will return an array containing up to\
\ 500 tags sorted by descending popularity.\n\nCheck out related examples:\n\n * Get Tags (\n\
\ <a href=\"https://github.com/aweber/public-api-examples/blob/master/python/get-tags\" target=\"\
_blank\">Python</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/php/get-tags\"\
\ target=\"_blank\">PHP</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/postman/Get%20Tags.postman_collection.json\"\
\ target=\"_blank\">Postman</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/csharp/AWeber.Examples.GetTags/\"\
\ target=\"_blank\">C#.NET</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/ruby/get_tags.rb\"\
\ target=\"_blank\">Ruby</a> |\n <a href=\"https://github.com/aweber/public-api-examples/blob/master/node/get-tags.js\"\
\ target=\"_blank\">Node.js</a> )"
tags:
- Lists
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/listId'
security:
- OAuth 2.0:
- list.read
x-code-samples:
- lang: Shell
source: "curl -G \\\n https://api.aweber.com/1.0/accounts/{accountId}/lists/{listId}/tags \\\n\
\ -H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}'\n"
- lang: Python
source: "headers = {'Accept': 'application/json',\n 'User-Agent': 'AWeber-Python-code-sample/1.0',\n\
\ 'Authorization': f'Bearer {access_token}'}\nurl = f'https://api.aweber.com/1.0/accounts/{account_id}/lists/{list_id}/tags'\n\
response = requests.get(url, headers=headers)\nprint(response.json())\n"
- lang: PHP
source: "$headers = [\n 'User-Agent' => 'AWeber-PHP-code-sample/1.0',\n 'Accept' => 'application/json',\n\
\ 'Authorization' => 'Bearer $token',\n];\n$url = \"https://api.aweber.com/1.0/accounts/{$accountId}/lists/{$listId}/tags\"\
;\n$response = $client->get($url, ['headers' => $headers]);\n$body = json_decode($response->getBody(),\
\ true);\nprint_r($body);\n"
- lang: C#
source: 'const string url = "https://api.aweber.com/1.0/accounts/{accountId}/lists/{listId}/tags";
var request = new HttpRequestMessage(HttpMethod.Get, url);
request.Headers.Add("Accept","application/json");
request.Headers.Add("User-Agent","AWeber-CSharp-code-sample/1.0");
request.Headers.Add("Authorization", $"Bearer {Token}");
var response = await Client.SendAsync(request);
Console.Write(response.Content.ReadAsStringAsync());
'
- lang: JavaScript
label: Node.js
source: "const headers = {\n \"Accept\": \"application/json\",\n \"User-Agent\": \"AWeber-Node-code-sample/1.0\"\
,\n \"Authorization\": `Bearer ${accessToken}`\n};\nconst url = `https://api.aweber.com/1.0/accounts/${accountId}/lists/${listId}/tags`;\n\
fetch(url, { headers: headers })\n .then(response => response.json())\n .then(data => {\n\
\ console.log(data)\n})\n"
- lang: Ruby
source: "headers = {\n 'Accept': 'application/json',\n 'User-Agent': 'AWeber-Ruby-code-sample/1.0',\n\
\ 'Authorization': \"Bearer #{access_token}\"\n}\nresponse = Faraday.get(\n \"https://api.aweber.com/1.0/accounts/#{account_id}/lists/#{list_id}/tags\"\
\n) do |req|\n req.headers = headers\nend\nputs response.body\n"
responses:
'200':
description: The request completed successfully
content:
application/json:
schema:
type: array
items:
type: string
example:
- alpha
- beta
- gamma
'400':
description: The server cannot or will not process the request due to a client error
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
One of the following errors may be received:
| Error Type | Explanation |
|----------------------|------------------------------------------|
| BadRequestError | There was an error decoding query parameters |
| MissingOAuthParametersError | An OAuth parameter is missing in the request |
| UnsupportedOAuthVersionError | Unsupported OAuth 1 version |
| UnsupportedOAuthSignatureMethodError | Unsupported OAuth 1 signature method |
Please see the message body for more details.
'
type: object
properties:
documentation_url:
description: A link to the documentation that describes the error
type: string
example: https://api.aweber.com#badrequest
message:
description: A human friendly description of the error
type: string
example: Maximum for "ws.size" parameter is 100.
status:
description: The HTTP status code
type: integer
example: 400
type:
description: The API error type
type: string
example: WebServiceError
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/BlockedError'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
operationId: getTagsForList
components:
parameters:
accountId:
name: accountId
in: path
description: The account ID
required: true
schema:
type: integer
format: int32
listId:
name: listId
in: path
description: The list ID
required: true
schema:
type: integer
format: int32
wsShow:
name: ws.show
in: query
description: A flag to show the total size only - expecting \"total_size\", when added the response
will be an integer
schema:
type: string
enum:
- total_size
wsSize:
name: ws.size
in: query
description: The pagination total entries to retrieve
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 100
wsStart:
name: ws.start
in: query
description: The pagination starting offset
schema:
type: integer
format: int32
minimum: 0
default: 0
responses:
BadOAuth1:
description: The server cannot or will not process the request due to a client error
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
One of the following errors may be received:
| Error Type | Explanation |
|--------------------------------------|------------------------------------------|
| BadRequestError | There was an error decoding query parameters
|
| MissingOAuthParametersError | An OAuth parameter is missing in the request
|
| UnsupportedOAuthSignatureMethodError | The provided OAuth 1 signature method is unsupported.
Only HMAC-SHA1 is supported. |
| UnsupportedOAuthVersionError | The provided OAuth 1 version is unsupported.
|
Please see the message body for more details.
'
type: object
properties:
documentation_url:
description: A link to the documentation that describes the error
type: string
example: https://api.aweber.com#badrequest
message:
description: A human friendly description of the error
type: string
example: 'Missing oauth parameters: oauth_consumer_key'
status:
description: The HTTP status code
type: integer
enum:
- 400
type:
description: The API error type
type: string
enum:
- MissingOAuthParametersError
BlockedError:
description: The request has been blocked
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
The following error may be received:
| Error Type | Explanation |
|----------------------|------------------------------------------|
| BlockedError | This Request has been blocked |
Please see the message body for more details.
'
type: object
properties:
documentation_url:
description: A link to the documentation that describes the error
type: string
example: https://api.aweber.com/#blocked
message:
description: A human friendly description of the error
type: string
example: Blocked Error
status:
description: The HTTP status code
type: integer
enum:
- 410
type:
description: The API error type
type: string
enum:
- BlockedError
ForbiddenError:
description: The request could not be completed due to a rate limit error
content:
application/json:
schema:
type: object
properties:
error:
description: 'An error object.
The following error may be received:
| Error Type | Explanation |
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aweber/refs/heads/main/openapi/aweber-lists-api-openapi.yml