REST API endpoints for managing users and team members

The users and invites endpoints give you programmatic control over your LeadScout team. You can list current members, invite new reps or admins by email, update a user’s role and permissions, and remove users who have left the team. Most of these endpoints require the admin or owner role — a sales user can read the team list but cannot manage it.

List team members

GET /api/users

Returns all active (non-deleted) users in your company, ordered newest first.

curl --request GET \
  --url https://app.leadscoutapp.com/api/users \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const response = await fetch('https://app.leadscoutapp.com/api/users', {
  headers: { Authorization: `Bearer ${accessToken}` },
});
const users = await response.json();

Response

Returns an array of user objects directly.

number

User ID.

string

First name.

string

Last name.

string

Email address.

string | null

Phone number.

string

owner, admin, or sales.

boolean

Whether this user can perform prospect management actions regardless of role.

boolean

Whether this user can create and modify tags regardless of role.

boolean

Whether this is the primary account holder.

string | null

IANA time zone string.

boolean

Whether the app auto-detects the user’s time zone.

string | null

Start of working hours (e.g. "08:00").

string | null

End of working hours (e.g. "17:00").

number | null

Appointment buffer time in minutes.

boolean

Whether the user prefers 24-hour time display.

boolean

Whether the user’s calendar shows all company events.

string

ISO 8601 creation timestamp.

Invite a user

POST /api/invites

Inviting users requires the admin or owner role. Requests from sales users return 403.

Sends an invitation for a new team member. The invite is stored and the invitee receives an email with instructions to complete sign-up. You can only invite users with the admin or sales role — the owner role cannot be assigned through invitations.

Request body

string

required

Invitee’s first name.

string

required

Invitee’s last name.

string

required

Must be a valid email address. Used as the login identifier.

string

Optional phone number for the invitee.

string

required

Role to grant on acceptance. Must be admin or sales.

string

ISO 8601 timestamp after which the invite link expires. If omitted, the invite does not expire.

Returns 201 with the created invite object on success.

curl --request POST \
  --url https://app.leadscoutapp.com/api/invites \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "Alex",
    "lastName": "Rivera",
    "email": "alex.rivera@example.com",
    "role": "sales",
    "expiresAt": "2024-12-31T23:59:59Z"
  }'

const response = await fetch('https://app.leadscoutapp.com/api/invites', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    firstName: 'Alex',
    lastName: 'Rivera',
    email: 'alex.rivera@example.com',
    role: 'sales',
    expiresAt: '2024-12-31T23:59:59Z',
  }),
});
const invite = await response.json();

Update a user

PATCH /api/users/:id

Updating another user’s role or permissions (role, isPrimary, canManageTags, canManageProspects) requires the canManageTeam permission, which is granted to admin and owner roles. Users can update their own profile fields (name, email, phone, time zone, calendar preferences) without elevated permissions.

All body fields are optional. Only the fields you send are updated.

Path parameters

number

required

The user ID to update.

Request body

Profile fields (any user can update on themselves):

string

First name. Must be at least 1 character.

string

Last name. Must be at least 1 character.

string

Valid email address.

string

Phone number. Pass null to clear.

string

IANA time zone string (e.g. America/Detroit).

boolean

Whether to auto-detect time zone from the device.

string

Working hours start time string (e.g. "08:00").

string

Working hours end time string (e.g. "17:00").

number

Integer appointment buffer in minutes.

boolean

Whether to display times in 24-hour format.

boolean

Whether the calendar shows all company events.

Admin/owner only fields:

string

New role: owner, admin, or sales.

boolean

Whether to mark this user as the primary account holder.

boolean

Grant or revoke tag management permission.

boolean

Grant or revoke prospect management permission.

curl --request PATCH \
  --url https://app.leadscoutapp.com/api/users/14 \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "admin",
    "canManageProspects": true
  }'

const response = await fetch('https://app.leadscoutapp.com/api/users/14', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${accessToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    role: 'admin',
    canManageProspects: true,
  }),
});
const updated = await response.json();

Remove a user

DELETE /api/users/:id

Removing a user requires the admin or owner role. The user’s prospects and activity history are preserved, but they can no longer sign in.

Path parameters

number

required

The user ID to remove.

Returns { "id": <number> } on success.

curl --request DELETE \
  --url https://app.leadscoutapp.com/api/users/14 \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

await fetch('https://app.leadscoutapp.com/api/users/14', {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${accessToken}` },
});

Overview

Endpoints

REST API endpoints for managing users and team members

List team members

Response

Invite a user

Request body

Update a user

Path parameters

Request body

Remove a user

Path parameters

​List team members

​Response

​Invite a user

​Request body

​Update a user

​Path parameters

​Request body

​Remove a user

​Path parameters

List team members

Response

Invite a user

Request body

Update a user

Path parameters

Request body

Remove a user

Path parameters