Working with your account

​

Overview

Accounts in Mudstack represent the top-level entity for organizing and managing your content. They are used by users, teams, or studios to group workspaces and their associated entities. All content within an account is isolated and cannot be accessed without specifying the appropriate x-account-id header in every API request.

​

Key Concepts

​

Accounts

• Definition: An account is the primary container for all your workspaces and your team members.
• Ownership: All content inside an account belongs exclusively to that account.
• Access Control: API requests must include the x-account-id header to interact with account-specific resources.

​

Entities within Accounts

Accounts own various entities, including:

• Workspaces: Containers environments for assets, tags, libraries, and tasks.
• Invites: Pending invitations for new members.
• History: Logs of account activities.
• Members: Users associated with the account.
• Settings: Configuration options for the account.

​

API Headers

To interact with accounts, include the following headers in your API requests:

• Authorization: Bearer token for authentication.
• x-account-id: The unique identifier of the account you want to access.

Example:

GET /accounts HTTP/1.1
Host: api.mudstack.com
Authorization: Bearer <your-token>
x-account-id: <account-id>

​

Common API Endpoints

​

1. Account

• Get User Accounts: GET /users/accounts (no x-account-id required)
• Get Account Metadata: GET /accounts
• Update Account: PUT /accounts
• Delete Account: DELETE /accounts
• Get Account Thumbnail: GET /accounts

​

2. Account Members

• Get Members: GET /accounts/members
• Update Member: PUT /accounts/members/{member_id}
• Delete Member: DELETE /accounts/members/{member_id}

​

3. List Workspaces in an Account

• Get Workspaces: GET /accounts/workspaces

​

4. Account Settings

• Get Settings: GET /accounts/settings
• Update Setting: PUT /accounts/settings/{setting_id}

​

5. Account History

• Get History: GET /accounts/history

​

6. Account Invites

• Get Invites: GET /accounts/invites
• Create Invite: POST /accounts/invites
• Delete Invite: DELETE /accounts/invites/{invite_id}

​

Additional Information

For more API endpoints, refer to the API Reference.