Skip to main content

Accounts API

Documentation for the Drum Accounts API endpoint

Ben Walker avatar
Written by Ben Walker
Updated over 11 months ago

List Accounts

Retrieves all accounts associated with the authenticated user.

GET /api/v1/accounts

Response

Returns an array of account objects with the following attributes:

[
{
"id": string,
"name": string,
"personal": boolean,
"owner_id": integer,
"created_at": datetime,
"updated_at": datetime,
"account_users": [
{
"id": integer,
"user_id": integer
"discarded_at": datetime
}
]
}
]

Response Fields

Field

Type

Description

id

string

Unique identifier for the account - used for additional requests against this account -e.g. projects

name

string

Name of the account

owner_id

integer

User ID of the account owner

account_users

array

List of users associated with this account

Account User Response Fields

Field

Type

Description

id

integer

Unique identifier for the account user

user_id

integer

Unique identifier for the associate user

discarded_at

datetime

The date and time that the account user was archived

Authentication

This endpoint requires user authentication. Include your API token in the request headers.

Example Request

curl -H "Authorization: Bearer YOUR_API_TOKEN" https://api.example.com/api/v1/accounts


​

Did this answer your question?