View Account Details via API

This method allows you to view the details of your DeployHQ account, including plan information, project limits, and account status.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/account

HTTP Method

GET

Supported Parameters

This endpoint does not accept any parameters.

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/account

Example Response

{
  "name": "zbigw",
  "permalink": "zbigw",
  "time_zone": "Etc/UTC",
  "package": "premium_2020",
  "trialling": false,
  "suspended": false,
  "project_count": 7,
  "project_limit": 48,
  "users_allowed": true
}

Notes

• The package field indicates the current plan the account is on
• The trialling field indicates whether the account is currently on a trial period
• The suspended field indicates whether the account has been suspended
• The project_count and project_limit fields show how many projects are in use and the maximum allowed
• The users_allowed field indicates whether the account plan permits additional users