MailChimp Assistant by Mojju
MailChimp Assistant by Mojju · Ações GPT
Mailchimp API Integration
An OpenAPI specification for Mailchimp API endpoints including Campaigns, Lists/Audiences, and List Members.
GET /campaignscampaignsGet all campaigns in an account.
GET /campaigns/{campaign_id}campaignGet information about a specific campaign.
GET /listslistsGet information about all lists/audiences in the account.
GET /lists/{list_id}listGet detailed information about a specific list/audience.
GET /lists/{list_id}/memberslistMembersList information about members in a specific list.
GET /lists/{list_id}/members/{subscriber_hash}listMemberGet information about a specific list member.
Esquema API original
{
"openapi": "3.1.0",
"info": {
"title": "Mailchimp API Integration",
"description": "An OpenAPI specification for Mailchimp API endpoints including Campaigns, Lists/Audiences, and List Members.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://api.mailchimp.com/3.0/"
}
],
"paths": {
"/campaigns": {
"get": {
"description": "Get all campaigns in an account.",
"operationId": "campaigns",
"parameters": [
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this is the number of records from a collection to skip. Default value is 0.",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "type",
"in": "query",
"description": "The campaign type. Possible values: \"regular\", \"plaintext\", \"absplit\", \"rss\", or \"variate\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
}
},
{
"name": "status",
"in": "query",
"description": "The status of the campaign. Possible values: \"save\", \"paused\", \"schedule\", \"sending\", or \"sent\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent"
]
}
},
{
"name": "before_send_time",
"in": "query",
"description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_send_time",
"in": "query",
"description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_create_time",
"in": "query",
"description": "Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_create_time",
"in": "query",
"description": "Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "list_id",
"in": "query",
"description": "The unique id for the list.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "folder_id",
"in": "query",
"description": "The unique folder id.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member_id",
"in": "query",
"description": "Retrieve campaigns sent to a particular list member. Member ID is the MD5 hash of the lowercase version of the list member’s email address.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible values: \"create_time\" or \"send_time\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"create_time",
"send_time"
]
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: \"ASC\" or \"DESC\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
}
]
}
},
"/campaigns/{campaign_id}": {
"get": {
"description": "Get information about a specific campaign.",
"operationId": "campaign",
"parameters": [
{
"name": "campaign_id",
"in": "path",
"required": true,
"description": "The unique id for the campaign.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
}
]
}
},
"/lists": {
"get": {
"description": "Get information about all lists/audiences in the account.",
"operationId": "lists",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000.",
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this is the number of records from a collection to skip. Default value is 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "before_date_created",
"in": "query",
"description": "Restrict response to lists created before the set date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_date_created",
"in": "query",
"description": "Restrict results to lists created after the set date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_campaign_last_sent",
"in": "query",
"description": "Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_campaign_last_sent",
"in": "query",
"description": "Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "email",
"in": "query",
"description": "Restrict results to lists that include a specific subscriber's email address.",
"schema": {
"type": "string",
"format": "email"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible value: 'date_created'.",
"schema": {
"type": "string",
"enum": [
"date_created"
]
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: 'ASC' or 'DESC'.",
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
{
"name": "has_ecommerce_store",
"in": "query",
"description": "Restrict results to lists that contain an active, connected, undeleted ecommerce store.",
"schema": {
"type": "boolean"
}
},
{
"name": "include_total_contacts",
"in": "query",
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.",
"schema": {
"type": "boolean"
}
}
]
}
},
"/lists/{list_id}": {
"get": {
"description": "Get detailed information about a specific list/audience.",
"operationId": "list",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "include_total_contacts",
"in": "query",
"required": false,
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.",
"schema": {
"type": "boolean"
}
}
]
}
},
"/lists/{list_id}/members": {
"get": {
"description": "List information about members in a specific list.",
"operationId": "listMembers",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000",
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this it the number of records from a collection to skip. Default value is 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "email_type",
"in": "query",
"description": "The email type.",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "The subscriber's status. Possible values: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional', or 'archived'.",
"schema": {
"type": "string"
}
},
{
"name": "since_timestamp_opt",
"in": "query",
"description": "Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_timestamp_opt",
"in": "query",
"description": "Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_last_changed",
"in": "query",
"description": "Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_last_changed",
"in": "query",
"description": "Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "unique_email_id",
"in": "query",
"description": "A unique identifier for the email address across all Mailchimp lists.",
"schema": {
"type": "string"
}
},
{
"name": "vip_only",
"in": "query",
"description": "A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.",
"schema": {
"type": "boolean"
}
},
{
"name": "interest_category_id",
"in": "query",
"description": "The unique id for the interest category.",
"schema": {
"type": "string"
}
},
{
"name": "interest_ids",
"in": "query",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma-separated list of interest ids present for any supplied interest categories.",
"schema": {
"type": "string"
}
},
{
"name": "interest_match",
"in": "query",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. 'any' will match a member with any of the interest supplied, 'all' will only match members with every interest supplied, and 'none' will match members without any of the interest supplied. Possible values: 'any', 'all', or 'none'.",
"schema": {
"type": "string"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible values: 'timestamp_opt', 'timestamp_signup', or 'last_changed'.",
"schema": {
"type": "string"
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: 'ASC' or 'DESC'.",
"schema": {
"type": "string"
}
},
{
"name": "since_last_campaign",
"in": "query",
"description": "Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.",
"schema": {
"type": "boolean"
}
},
{
"name": "unsubscribed_since",
"in": "query",
"description": "Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.",
"schema": {
"type": "string",
"format": "date-time"
}
}
]
}
},
"/lists/{list_id}/members/{subscriber_hash}": {
"get": {
"description": "Get information about a specific list member.",
"operationId": "listMember",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "subscriber_hash",
"in": "path",
"required": true,
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
}
}
},
"components": {
"schemas": {},
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://login.mailchimp.com/oauth2/authorize",
"tokenUrl": "https://login.mailchimp.com/oauth2/token",
"scopes": {}
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}Mailchimp API Integration
An OpenAPI specification for Mailchimp API endpoints including Campaigns, Lists/Audiences, and List Members.
GET /campaignscampaignsGet all campaigns in an account.
GET /campaigns/{campaign_id}campaignGet information about a specific campaign.
GET /listslistsGet information about all lists/audiences in the account.
GET /lists/{list_id}listGet detailed information about a specific list/audience.
GET /lists/{list_id}/memberslistMembersList information about members in a specific list.
GET /lists/{list_id}/members/{subscriber_hash}listMemberGet information about a specific list member.
Esquema API original
{
"openapi": "3.1.0",
"info": {
"title": "Mailchimp API Integration",
"description": "An OpenAPI specification for Mailchimp API endpoints including Campaigns, Lists/Audiences, and List Members.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://api.mailchimp.com/3.0/"
}
],
"paths": {
"/campaigns": {
"get": {
"description": "Get all campaigns in an account.",
"operationId": "campaigns",
"parameters": [
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this is the number of records from a collection to skip. Default value is 0.",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "type",
"in": "query",
"description": "The campaign type. Possible values: \"regular\", \"plaintext\", \"absplit\", \"rss\", or \"variate\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
}
},
{
"name": "status",
"in": "query",
"description": "The status of the campaign. Possible values: \"save\", \"paused\", \"schedule\", \"sending\", or \"sent\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent"
]
}
},
{
"name": "before_send_time",
"in": "query",
"description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_send_time",
"in": "query",
"description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_create_time",
"in": "query",
"description": "Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_create_time",
"in": "query",
"description": "Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "list_id",
"in": "query",
"description": "The unique id for the list.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "folder_id",
"in": "query",
"description": "The unique folder id.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member_id",
"in": "query",
"description": "Retrieve campaigns sent to a particular list member. Member ID is the MD5 hash of the lowercase version of the list member’s email address.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible values: \"create_time\" or \"send_time\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"create_time",
"send_time"
]
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: \"ASC\" or \"DESC\".",
"required": false,
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
}
]
}
},
"/campaigns/{campaign_id}": {
"get": {
"description": "Get information about a specific campaign.",
"operationId": "campaign",
"parameters": [
{
"name": "campaign_id",
"in": "path",
"required": true,
"description": "The unique id for the campaign.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": false
}
]
}
},
"/lists": {
"get": {
"description": "Get information about all lists/audiences in the account.",
"operationId": "lists",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000.",
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this is the number of records from a collection to skip. Default value is 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "before_date_created",
"in": "query",
"description": "Restrict response to lists created before the set date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_date_created",
"in": "query",
"description": "Restrict results to lists created after the set date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_campaign_last_sent",
"in": "query",
"description": "Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_campaign_last_sent",
"in": "query",
"description": "Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: YYYY-MM-DDTHH:MM:SS+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "email",
"in": "query",
"description": "Restrict results to lists that include a specific subscriber's email address.",
"schema": {
"type": "string",
"format": "email"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible value: 'date_created'.",
"schema": {
"type": "string",
"enum": [
"date_created"
]
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: 'ASC' or 'DESC'.",
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
{
"name": "has_ecommerce_store",
"in": "query",
"description": "Restrict results to lists that contain an active, connected, undeleted ecommerce store.",
"schema": {
"type": "boolean"
}
},
{
"name": "include_total_contacts",
"in": "query",
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.",
"schema": {
"type": "boolean"
}
}
]
}
},
"/lists/{list_id}": {
"get": {
"description": "Get detailed information about a specific list/audience.",
"operationId": "list",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"required": false,
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "include_total_contacts",
"in": "query",
"required": false,
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.",
"schema": {
"type": "boolean"
}
}
]
}
},
"/lists/{list_id}/members": {
"get": {
"description": "List information about members in a specific list.",
"operationId": "listMembers",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "count",
"in": "query",
"description": "The number of records to return. Default value is 10. Maximum value is 1000",
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000
}
},
{
"name": "offset",
"in": "query",
"description": "Used for pagination, this it the number of records from a collection to skip. Default value is 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "email_type",
"in": "query",
"description": "The email type.",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "The subscriber's status. Possible values: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional', or 'archived'.",
"schema": {
"type": "string"
}
},
{
"name": "since_timestamp_opt",
"in": "query",
"description": "Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_timestamp_opt",
"in": "query",
"description": "Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "since_last_changed",
"in": "query",
"description": "Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "before_last_changed",
"in": "query",
"description": "Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "unique_email_id",
"in": "query",
"description": "A unique identifier for the email address across all Mailchimp lists.",
"schema": {
"type": "string"
}
},
{
"name": "vip_only",
"in": "query",
"description": "A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.",
"schema": {
"type": "boolean"
}
},
{
"name": "interest_category_id",
"in": "query",
"description": "The unique id for the interest category.",
"schema": {
"type": "string"
}
},
{
"name": "interest_ids",
"in": "query",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma-separated list of interest ids present for any supplied interest categories.",
"schema": {
"type": "string"
}
},
{
"name": "interest_match",
"in": "query",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. 'any' will match a member with any of the interest supplied, 'all' will only match members with every interest supplied, and 'none' will match members without any of the interest supplied. Possible values: 'any', 'all', or 'none'.",
"schema": {
"type": "string"
}
},
{
"name": "sort_field",
"in": "query",
"description": "Returns files sorted by the specified field. Possible values: 'timestamp_opt', 'timestamp_signup', or 'last_changed'.",
"schema": {
"type": "string"
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Determines the order direction for sorted results. Possible values: 'ASC' or 'DESC'.",
"schema": {
"type": "string"
}
},
{
"name": "since_last_campaign",
"in": "query",
"description": "Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.",
"schema": {
"type": "boolean"
}
},
{
"name": "unsubscribed_since",
"in": "query",
"description": "Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.",
"schema": {
"type": "string",
"format": "date-time"
}
}
]
}
},
"/lists/{list_id}/members/{subscriber_hash}": {
"get": {
"description": "Get information about a specific list member.",
"operationId": "listMember",
"parameters": [
{
"name": "list_id",
"in": "path",
"required": true,
"description": "The unique ID for the list.",
"schema": {
"type": "string"
}
},
{
"name": "subscriber_hash",
"in": "path",
"required": true,
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id.",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
]
}
}
},
"components": {
"schemas": {},
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://login.mailchimp.com/oauth2/authorize",
"tokenUrl": "https://login.mailchimp.com/oauth2/token",
"scopes": {}
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}