Accounts

On this page, we'll dive into the accounts endpoints you can use to manage accounts programmatically. Currently, we only allow querying accounts via API.

The account model

The account model contains all the information about your accounts, such as their unique identifier, owner identifier etc.

Properties

Name
uuid
Type
string
Description
Unique identifier for the account.
Name
name
Type
string
Description
Name of the account.
Name
personal
Type
boolean
Description
Whether the account is personal or not.
Name
owner_uuid
Type
string
Description
Unique identifier for the account owner.
Name
created_at
Type
timestamp
Description
Timestamp of when the account was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the account was last updated.

GET/api/v1/accounts

List all accounts

This endpoint allows you to retrieve a list of all your accounts.

Request

GET

/api/v1/accounts

curl -G https://app.saascustomdomains.com/api/v1/accounts \
  -H "Authorization: Bearer {token}"

Response

[
    {
        "uuid": "acc_d36c56a34db0",
        "name": "Rocky Balboa",
        "personal": true,
        "created_at": "2022-11-06T22:49:39.923+01:00",
        "updated_at": "2022-11-20T19:50:31.977+01:00",
        "owner_uuid": "u_33e1d4c2105b"
    },
    {
        "uuid": "acc_e47kk6a34db0",
        // ...
    },
    // ...
]