MAmailchimp
root

List API root resources

Get links to all other resources available in the API.

get/3.0/

Request

  • Base URL
    https://api.mailchimp.com
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://login.mailchimp.com/oauth2/authorize
      Token URLhttps://login.mailchimp.com/oauth2/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

Response

account_idstring

The Mailchimp account ID.

account_industrystring

The user-specified industry associated with the account.

account_namestring

The name of the account.

account_timezonestring

The timezone currently set for the account.

avatar_urlstring

URL of the avatar for the user.

emailstring

The account email address.

first_namestring

The first name tied to the account.

last_loginstring date-time

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

last_namestring

The last name tied to the account.

login_idstring

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_sincestring date-time

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

pricing_plan_type'monthly' | 'pay_as_you_go' | 'forever_free'

The type of pricing plan the account is on.

pro_enabledboolean

Legacy - whether the account includes Mailchimp Pro.

rolestring

The user role for the account.

total_subscribersinteger

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

usernamestring

The username tied to the account.

Example response

{
  "member_since": "2010-01-01T23:59:59Z",
  "username": "freddie2000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.