Users

cURL Ruby

List all users

GET /users(.:format)

Returns a list of users within the administration.

Parameters

Parameter Type Description
include_inactive Grape::api::boolean
include_accountants Grape::api::boolean
include_api_users Grape::api::boolean

Example: returns all active users of an administration

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  },
  {
    "id": "458577199040038163",
    "name": "John Doe",
    "created_at": "2025-07-03T14:35:18.534Z",
    "updated_at": "2025-07-03T14:35:18.540Z",
    "email": "john+3@doe.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "employee",
    "permissions": [
      "time_entries"
    ]
  }
]

Example: only includes permission for users with this administration

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  },
  {
    "id": "458577199179498773",
    "name": "A. Arend.",
    "created_at": "2025-07-03T14:35:18.667Z",
    "updated_at": "2025-07-03T14:35:18.998Z",
    "email": "john+3@doe.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "employee",
    "permissions": [
      "time_entries"
    ]
  }
]

Example: includes api users when include_api_users is true

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?include_api_users=true

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  },
  {
    "id": 1,
    "name": "Edwin Vlieg",
    "created_at": "2025-07-03T14:35:19.102Z",
    "updated_at": "2025-07-03T14:35:19.108Z",
    "email": "example+1@dev.null.moneybird.net",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "api_user",
    "permissions": [
      "time_entries"
    ]
  }
]

Example: does not include api users when include_api_users is false

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  }
]

Example: includes accounts when include_accountants is true

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?include_accountants=true

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  },
  {
    "id": "458577199911404877",
    "name": "A. Accountant.",
    "created_at": "2025-07-03T14:35:19.365Z",
    "updated_at": "2025-07-03T14:35:19.371Z",
    "email": "john+3@doe.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "accountant",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "time_entries"
    ]
  }
]

Example: includes inactive users when include_inactive is true

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/users.json?include_inactive=true

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "458576877408224357",
    "name": "Mo Neybird",
    "created_at": "2025-07-03T14:30:11.803Z",
    "updated_at": "2025-07-03T14:30:12.123Z",
    "email": "info@moneybird.nl",
    "email_validated": true,
    "language": "nl",
    "time_zone": "Europe/Amsterdam",
    "user_type": "owner",
    "permissions": [
      "sales_invoices",
      "documents",
      "estimates",
      "bank",
      "settings",
      "ownership",
      "time_entries"
    ]
  },
  {
    "id": "458577200038282575",
    "name": "A. User.",
    "created_at": "2025-07-03T14:35:19.486Z",
    "updated_at": "2025-07-03T14:35:19.499Z"
  }
]