API Root
The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.
Available methods
API Root
GET /
Get links to all other resources available in the API.
Query string parameters
fields
Type: Array
Title: Fields
Read only: false
A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields
Type: Array
Title: Exclude Fields
Read only: false
A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
Response body parameters
account_id
Type: String
Title: Account ID
Read only: true
The Mailchimp account ID, used for features like list subscribe forms .
login_id
Type: String
Title: Login ID
Read only: false
The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account.
account_name
Type: String
Title: Account Name
Read only: true
The name of the account.
email
Type: String
Title: Account Email
Read only: true
The account email address.
first_name
Type: String
Title: First Name
Read only: true
The first name tied to the account.
last_name
Type: String
Title: Last Name
Read only: true
The last name tied to the account.
username
Type: String
Title: User Name
Read only: true
The username tied to the account.
avatar_url
Type: String
Title: Avatar URL
Read only: true
URL of the avatar for the user.
role
Type: String
Title: Role
Read only: true
The user role for the account.
member_since
Type: String
Title: Account Creation Date
Read only: false
The date and time that the account was created in ISO 8601 format.
pricing_plan_type
Type: String
Title: Account Pricing Plan
Read only: false
The type of pricing plan the account is on.
Possible Values:
monthly
pay_as_you_go
forever_free
first_payment
Type: String
Title: First Payment
Read only: false
Date of first payment for monthly plans.
account_timezone
Type: String
Title: Account Timezone
Read only: false
The timezone currently set for the account.
account_industry
Type: String
Title: Account Industry
Read only: false
The user-specified industry associated with the account.
contact
Type: Object
Title: Account Contact
Read only: true
Information about the account contact.
Show properties
company
Type: String
Title: Company
Read only: true
The company name for the account.
addr1
Type: String
Title: Address Line 1
Read only: true
The street address for the account contact.
addr2
Type: String
Title: Address Line 2
Read only: true
The street address for the account contact.
city
Type: String
Title: City
Read only: true
The city for the account contact.
state
Type: String
Title: State
Read only: true
The state for the account contact.
zip
Type: String
Title: Zip Code
Read only: true
The zip code for the account contact.
country
Type: String
Title: Country
Read only: true
The country for the account contact.
pro_enabled
Type: Boolean
Title: Mailchimp Pro
Read only: true
Whether the account includes Mailchimp Pro .
last_login
Type: String
Title: Last Login Date
Read only: true
The date and time of the last login for this account in ISO 8601 format.
total_subscribers
Type: Integer
Title: Total Subscribers
Read only: true
The total number of subscribers across all lists in the account.
industry_stats
Type: Object
Title: Industry Stats
Read only: true
The average campaign statistics for all campaigns in the account’s specified industry.
Show properties
open_rate
Type: Number
Title: Open Rate
Read only: true
The average unique open rate for all campaigns in the account’s specified industry.
bounce_rate
Type: Number
Title: Bounce Rate
Read only: true
The average bounce rate for all campaigns in the account’s specified industry.
click_rate
Type: Number
Title: Click Rate
Read only: true
The average unique click rate for all campaigns in the account’s specified industry.
_links
Type: Array
Title: Links
Read only: true
A list of link types and descriptions for the API schema documents.
Show properties
rel
Type: String
Title: Rel
Read only: true
As with an HTML ‘rel’ attribute, this describes the type of link.
href
Type: String
Title: Href
Read only: true
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
method
Type: String
Title: Method
Read only: true
The HTTP method that should be used when accessing the URL defined in ‘href’.
Possible Values:
GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD
targetSchema
Type: String
Title: Target Schema
Read only: true
For GETs, this is a URL representing the schema that the response should conform to.
schema
Type: String
Title: Schema
Read only: true
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
Example request
curl --request GET \
--url 'https://usX.api.mailchimp.com/3.0/' \
--user 'anystring:apikey' \
--include
Example response
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 2340
Vary: Accept-Encoding
X-Request-Id: bca135bf-860c-4614-a07b-a70b062680c0
Link: <https://api.mailchimp.com/schema/3.0/Root.json>; rel="describedBy"
Date: Tue, 15 Sep 2015 15:13:50 GMT
Connection: keep-alive
{
"account_id": "8d3a3db4d97663a9074efcc16",
"account_name": "Freddie's Jokes",
"email": "freddie@mailchimp.com",
"role": "owner",
"contact": {
"company": "Freddie's Jokes",
"addr1": "675 Ponce De Leon Ave NE",
"addr2": "Suite 5000",
"city": "Atlanta",
"state": "GA",
"zip": "30308",
"country": "US"
},
"last_login": "2015-09-15 14:25:37",
"total_subscribers": 413,
"_links": [
{
"rel": "self",
"href": "https://usX.api.mailchimp.com/3.0/",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
},
{
"rel": "lists",
"href": "https://usX.api.mailchimp.com/3.0/lists",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
},
{
"rel": "reports",
"href": "https://usX.api.mailchimp.com/3.0/reports",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Reports.json"
},
{
"rel": "conversations",
"href": "https://usX.api.mailchimp.com/3.0/conversations",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Conversations/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Conversations.json"
},
{
"rel": "campaigns",
"href": "https://usX.api.mailchimp.com/3.0/campaigns",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
},
{
"rel": "automations",
"href": "https://usX.api.mailchimp.com/3.0/automations",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Automations.json"
},
{
"rel": "templates",
"href": "https://usX.api.mailchimp.com/3.0/templates",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Templates/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Templates.json"
},
{
"rel": "file-manager",
"href": "https://usX.api.mailchimp.com/3.0/file-manager",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Namespace.json"
},
{
"rel": "authorized-apps",
"href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
}
]
}
Error response
type
Type: String
Title: Problem Type
Read only: false
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
title
Type: String
Title: Error Title
Read only: false
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
status
Type: Integer
Title: HTTP Status Code
Read only: false
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
detail
Type: String
Title: Error Message
Read only: false
A human-readable explanation specific to this occurrence of the problem. Learn more about errors .
instance
Type: String
Title: Instance ID
Read only: false
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.