SuitePortal

Users API

API endpoints for user management.

Users API

This documentation is currently being developed. Check back soon for complete content.

List Users

GET /v1/users

Parameters

ParameterTypeDescription
organizationIdstringFilter by organization
rolestringFilter by role

Response

{
  "data": [
    {
      "id": "usr_123",
      "email": "user@example.com",
      "name": "John Doe",
      "role": "member"
    }
  ],
  "meta": {
    "total": 25
  }
}

Get User

GET /v1/users/:id

Invite User

POST /v1/users/invite

Request Body

{
  "email": "newuser@example.com",
  "organizationId": "org_123",
  "role": "member"
}

Update User Role

PATCH /v1/users/:id/role

Request Body

{
  "role": "admin"
}