Accounts API


List all accounts for a given user

GET /users/:user_id/accounts

Parameters

name
required: false
Name of an account
user_id
required: false
User ID of a User that belongs to an account
support_plan
required: false
Support plan of accounts
legacy_id
required: false
Support plan of accounts

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "e8369335-cf19-4aa8-8e6b-a9a8ecc16b94",
                "account_notes": "https://api.engineyard.com/accounts-notes.e8369335-cf19-4aa8-8e6b-a9a8ecc16b94",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/addons",
                "addresses": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/addresses",
                "applications": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/applications",
                "billable": true,
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2017-02-22T17:02:13+00:00",
                "database_services": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/environments",
                "features": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/features",
                "finalized": true,
                "memberships": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/memberships",
                "name": "account-e8369335-cf19-4aa8-8e6b-a9a8ecc16b94",
                "owners": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/providers",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/requests",
                "server_alerts": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2017-02-22T17:02:14+00:00",
                "users": "https://api.engineyard.com/accounts/e8369335-cf19-4aa8-8e6b-a9a8ecc16b94/users"
              }
            ]
          }
            
          








Update account's emergency contact

PUT /accounts/:account_id

Parameters

name
required: false
scope: account
Name of the account
emergency_contact
required: false
scope: account
My Emergency Contact

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
            "account": {
              "emergency_contact": "My New Emergency Contact"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "account": {
              "id": "507ce4cc-017b-4ca7-8c3a-74dca59eed40",
              "account_notes": "https://api.engineyard.com/accounts-notes.507ce4cc-017b-4ca7-8c3a-74dca59eed40",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/addons",
              "addresses": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/addresses",
              "applications": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/applications",
              "billable": true,
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2017-02-22T17:02:30+00:00",
              "database_services": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/database-services",
              "emergency_contact": "My New Emergency Contact",
              "environments": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/environments",
              "features": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/features",
              "finalized": true,
              "memberships": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/memberships",
              "name": "account-507ce4cc-017b-4ca7-8c3a-74dca59eed40",
              "owners": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/providers",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/requests",
              "server_alerts": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2017-02-22T17:02:39+00:00",
              "users": "https://api.engineyard.com/accounts/507ce4cc-017b-4ca7-8c3a-74dca59eed40/users"
            }
          }
            
          








Show an account

GET /accounts/:account_id

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "account": {
              "id": "a12fbba3-82e3-4bc9-b519-36cc33c24d4a",
              "account_notes": "https://api.engineyard.com/accounts-notes.a12fbba3-82e3-4bc9-b519-36cc33c24d4a",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/addons",
              "addresses": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/addresses",
              "applications": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/applications",
              "billable": true,
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2017-02-22T17:02:22+00:00",
              "database_services": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/database-services",
              "emergency_contact": null,
              "environments": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/environments",
              "features": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/features",
              "finalized": true,
              "memberships": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/memberships",
              "name": "account-a12fbba3-82e3-4bc9-b519-36cc33c24d4a",
              "owners": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/providers",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/requests",
              "server_alerts": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2017-02-22T17:02:22+00:00",
              "users": "https://api.engineyard.com/accounts/a12fbba3-82e3-4bc9-b519-36cc33c24d4a/users"
            }
          }
            
          








List all accounts

GET /accounts

Parameters

name
required: false
Name of an account (fuzzy partial-name case-insensitive matching)
name_exactly
required: false
Name of an account (exact matching)
user_id
required: false
User ID of a User that belongs to an account
support_plan
required: false
Support plan of accounts
legacy_id
required: false
Support plan of accounts

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "a16779bc-029c-433e-8797-c947eb8dd9dd",
                "account_notes": "https://api.engineyard.com/accounts-notes.a16779bc-029c-433e-8797-c947eb8dd9dd",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/addons",
                "addresses": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/addresses",
                "applications": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/applications",
                "billable": true,
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2017-02-22T17:02:05+00:00",
                "database_services": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/environments",
                "features": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/features",
                "finalized": true,
                "memberships": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/memberships",
                "name": "account-a16779bc-029c-433e-8797-c947eb8dd9dd",
                "owners": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/providers",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/requests",
                "server_alerts": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2017-02-22T17:02:05+00:00",
                "users": "https://api.engineyard.com/accounts/a16779bc-029c-433e-8797-c947eb8dd9dd/users"
              }
            ]
          }