Authorized Apps

Manage registered, connected apps for your MailChimp account with the Authorized Apps endpoints.

Available methods

    • POST /authorized-apps Link your application

      Link your application

      POST /authorized-apps

      Retrieve OAuth2-based credentials to associate API calls with your application.

      Request body parameters

      client_id Type: String Title: Client ID Read only: false The client’s unique id/username for authorization.
      client_secret Type: String Title: Client Secret Read only: false The client password for authorization.

      Response body parameters

      access_token Type: String Title: Access Token Read only: false The access token issued by the auth server.
      viewer_token Type: String Title: Viewer Token Read only: false The viewer token issued by the auth server.
      _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.

      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.
    • GET /authorized-apps Get a list of authorized apps
      GET /authorized-apps/{app_id} Get information about a specific authorized app

      Get a list of authorized apps

      GET /authorized-apps

      Get a list of an account’s registered, connected applications.

      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.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.

      Response body parameters

      apps Type: Array Title: Authorized Applications Read only: false An array of objects, each representing an authorized application.
      Show properties
      id Type: Integer Title: Client ID Read only: false The ID for the application.
      name Type: String Title: Application Name Read only: false The name of the application.
      description Type: String Title: Application Description Read only: false A short description of the application.
      users Type: Array Title: Application Users Read only: false An array of usernames for users who have linked the app.
      _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.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _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/authorized-apps' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2291
      Vary: Accept-Encoding
      X-Request-Id: 72a58fde-64f2-4c30-bb06-561bca691d39
      Link: <https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 15:17:51 GMT
      Connection: keep-alive
      
      
      {
        "apps": [
          {
            "id": 248682284215,
            "name": "MailChimp for Shopify",
            "description": "MailChimp for Shopify is a free application that connects your Shopify store with your MailChimp account.",
            "users": [
              "freddiesjokes"
            ],
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps/248682284215",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
              }
            ]
          },
          {
            "id": 269255016790,
            "name": "Integrations Directory Reviews",
            "description": "Allow customers to leave feedback on the connect.mailchimp.com site.",
            "users": [
              "freddiesjokes"
            ],
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps/269255016790",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
              }
            ]
          },
          {
            "id": 274985087383,
            "name": "Goooal",
            "description": "Segment your MailChimp list based on subscribers' activity on your website.",
            "users": [
              "freddiesjokes"
            ],
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps/274985087383",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
              }
            ]
          }
        ],
        "total_items": 3,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
            "method": "POST",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/ClientAccessTokens.json",
            "schema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Client.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.

      Get information about a specific authorized app

      GET /authorized-apps/{app_id}

      Get information about a specific authorized application.

      Path parameters

      app_id The unique id for the connected authorized application.

      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

      id Type: Integer Title: Client ID Read only: false The ID for the application.
      name Type: String Title: Application Name Read only: false The name of the application.
      description Type: String Title: Application Description Read only: false A short description of the application.
      users Type: Array Title: Application Users Read only: false An array of usernames for users who have linked the app.
      _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/authorized-apps/248682284215' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 578
      Vary: Accept-Encoding
      X-Request-Id: 53564516-2f33-4d1a-99e0-0396cdccaa97
      Link: <https://api.mailchimp.com/schema/3.0/AuthorizedApps/Instance.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 15:22:57 GMT
      Connection: keep-alive
      
      
      {
        "id": 248682284215,
        "name": "MailChimp for Shopify",
        "description": "MailChimp for Shopify is a free application that connects your Shopify store with your MailChimp account.",
        "users": [
          "freddiesjokes"
        ],
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/authorized-apps/248682284215",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Instance.json"
          },
          {
            "rel": "parent",
            "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.