GET
/
accounts
curl --request GET \
  --url https://api.mudstack.com/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "account_tier_id": "<string>",
    "thumbnail_file_id": "<string>",
    "created_by_user_id": "<string>",
    "defaultAvatar": 123,
    "sequence": 123,
    "subscription": {
      "account_id": "<string>",
      "stripe_customer_id": "<string>",
      "status": "<string>",
      "licenses": 123,
      "frequency": "yearly",
      "contact": "<string>"
    },
    "members": {
      "account_id": "<string>",
      "user_id": "<string>",
      "roles": [
        "<string>"
      ],
      "user": {
        "id": "<string>",
        "auth0UserID": "<string>",
        "username": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatar_file_id": "<string>",
        "defaultAvatar": 123,
        "industry": "<string>",
        "occupation": "<string>",
        "company": "<string>",
        "emailVerified": true,
        "isActive": true,
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zipCode": "<string>",
        "invited_by_user": {}
      }
    },
    "tier": {
      "id": "<string>",
      "type": "personal",
      "name": "<string>",
      "maxStorage": 123,
      "costPerLicense": 123,
      "costPerExtraTB": 123
    },
    "type": {
      "id": "<string>",
      "name": "<string>",
      "maxStorage": 123,
      "maxAssets": 123,
      "maxUsers": 123,
      "costPerUser": 123,
      "addStoragePrice": 123
    },
    "creator": {
      "id": "<string>",
      "auth0UserID": "<string>",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatar_file_id": "<string>",
      "defaultAvatar": 123,
      "industry": "<string>",
      "occupation": "<string>",
      "company": "<string>",
      "emailVerified": true,
      "isActive": true,
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zipCode": "<string>",
      "invited_by_user": {}
    },
    "workspaces": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "defaultAvatar": 1,
        "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sequence": "<string>",
        "roles": {
          "workspace_id": "<string>",
          "user_id": "<string>",
          "roles": [
            "<string>"
          ],
          "user": {
            "id": "<string>",
            "auth0UserID": "<string>",
            "username": "<string>",
            "email": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "avatar_file_id": "<string>",
            "defaultAvatar": 123,
            "industry": "<string>",
            "occupation": "<string>",
            "company": "<string>",
            "emailVerified": true,
            "isActive": true,
            "city": "<string>",
            "state": "<string>",
            "country": "<string>",
            "zipCode": "<string>",
            "invited_by_user": {}
          }
        },
        "usage": {}
      }
    ],
    "isCreator": true,
    "account_roles": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-account-id
string
required

Response

200 - application/json
Permissions retrieved successfully
​
id
string

Unique identifier for the account.

​
name
string

Name of the account.

​
account_tier_id
string

Identifier for the account tier.

​
thumbnail_file_id
string

Optional identifier for the thumbnail file.

​
created_by_user_id
string

Optional identifier for the user who created the account.

​
defaultAvatar
number

Default avatar for the account.

​
sequence
integer

Sequence number for the account.

​
subscription
object

Optional subscription details for the account.

​
members
object

Optional members associated with the account.

​
tier
object

Optional tier details for the account.

​
type
object

Optional type details for the account.

​
creator
object

Optional creator details for the account.

​
workspaces
object[]

List of workspaces associated with the account.

​
isCreator
boolean

Optional flag indicating if the user is the creator of the account.

​
account_roles
string[]

Optional list of roles associated with the account.

Was this page helpful?