Moneybird logo
Moneybird API

Administrations can have multiple users. Use the following endpoints to get information about the users in an administration.


List all users

GET
https://moneybird.com/api/v2
/{administration_id}/users{format}

Returns a list of users within the administration.

Required scope(s)

settings

List all users › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all users › query Parameters

include_inactive
​boolean | string
include_accountants
​boolean | string
include_api_users
​boolean | string

List all users › Responses

A list of users

id
​identifier · pattern: ^\d+$

A unique record identifier

name
​string
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
email
​string
email_validated
​boolean
language
​string
time_zone
​string
user_type
​string · enum
Enum values:
end_user
api_user
system_user
deleted_end_user
deleted_api_user
owner
accountant
employee
permissions
​string[]
Enum values:
sales_invoices
documents
estimates
bank
settings
ownership
time_entries