List API root resources

GET

https://api.mailchimp.com/3.0/

GET

/3.0/

curl https://api.mailchimp.com/3.0/ \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "account_id": "string",
  "account_industry": "string",
  "account_name": "string",
  "account_timezone": "string",
  "avatar_url": "string",
  "contact": {
    "addr1": "string",
    "addr2": "string",
    "city": "string",
    "company": "string",
    "country": "string",
    "state": "string",
    "zip": "string"
  },
  "email": "string",
  "first_name": "string",
  "first_payment": "2010-01-01T23:59:59Z",
  "industry_stats": {
    "bounce_rate": 1.1,
    "click_rate": 1.1,
    "open_rate": 1.1
  },
  "last_login": "2024-01-15T09:30:00Z",
  "last_name": "string",
  "login_id": "string",
  "member_since": "2010-01-01T23:59:59Z",
  "pricing_plan_type": "monthly",
  "pro_enabled": true,
  "role": "string",
  "total_subscribers": 1,
  "username": "freddie2000"
}

Get links to all other resources available in the API.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

account_idstringOptionalRead-only

The Mailchimp account ID.

account_industrystringOptionalRead-only

The user-specified industry associated with the account.

account_namestringOptionalRead-only

The name of the account.

account_timezonestringOptionalRead-only

The timezone currently set for the account.

avatar_urlstringOptionalRead-only

URL of the avatar for the user.

contactobjectOptionalRead-only

Information about the account contact.

emailstringOptionalRead-only

The account email address.

first_namestringOptionalRead-only

The first name tied to the account.

first_paymentdatetime or ""OptionalRead-only

Date of first payment for monthly plans.

industry_statsobjectOptionalRead-only

The average campaign statistics for all campaigns in the account's specified industry.

last_logindatetimeOptionalRead-only

The date and time of the last login for this account in ISO 8601 format.

last_namestringOptionalRead-only

The last name tied to the account.

login_idstringOptionalRead-only

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.

member_sincedatetimeOptionalRead-only

The date and time that the account was created in ISO 8601 format.

pricing_plan_typeenumOptionalRead-only

The type of pricing plan the account is on.

Allowed values:

pro_enabledbooleanOptionalRead-only

Legacy - whether the account includes Mailchimp Pro.

rolestringOptionalRead-only

The user role for the account.

total_subscribersintegerOptionalRead-only

The total number of subscribers across all lists in the account.

usernamestringOptionalRead-only

The username tied to the account.