Spedy Docs

Users represent the people in your organization. You can invite new members, update their profiles, and manage their roles.

List Users

GET /api/v1/users

Permission required: members:view

Returns all users in the organization.

Example Response

[
  {
    "id": "usr_abc123",
    "email": "[email protected]",
    "name": "Alex Smith",
    "role": "ADMIN",
    "createdAt": "2025-01-15T10:00:00Z"
  },
  {
    "id": "usr_def456",
    "email": "[email protected]",
    "name": "Jamie Lee",
    "role": "TEAM_MEMBER",
    "createdAt": "2025-02-01T09:00:00Z"
  }
]

Create User (Invite)

POST /api/v1/users

Permission required: members:invite

Invite a new user to the organization. They'll receive an email with login credentials.

Request Body

Field	Type	Required	Description
email	string	Yes	User email address
name	string	Yes	User's full name
role	string	Yes	`ADMIN`, `TEAM_MEMBER`, or `CUSTOMER`
password	string	Yes	Initial password (min 8 chars, must include uppercase, lowercase, number, special char)

Example Request

{
  "email": "[email protected]",
  "name": "Jamie Lee",
  "role": "TEAM_MEMBER",
  "password": "SecureP@ss123"
}

Get User

GET /api/v1/users/{userId}

Permission required: members:view

Returns details for a specific user.

Update User

PATCH /api/v1/users/{userId}

Permission required: members:edit

Request Body

Field	Type	Required	Description
name	string	No	User's name
role	string	No	`ADMIN`, `TEAM_MEMBER`, or `CUSTOMER`

Update User Role

PATCH /api/v1/users/{userId}/role

Permission required: members:edit

Change a user's organization role.

Request Body

Field	Type	Required	Description
role	string	Yes	`ADMIN`, `TEAM_MEMBER`, or `CUSTOMER`

Users

List Users

Create User (Invite)

Get User

Update User

Update User Role

On this page