Users and Teams

Auth required: Yes (auth:api) for all endpoints.

Model Properties

User

Note: Passwords are managed separately and cannot be set via the API.

Team

Users

Base URL: /api/v1/users

GET /v1/users

List all users with filtering, sorting, and pagination.

Query parameters:

Response 200: Paginated list of user objects.

Returned columns: id, name, email, email_shown, avatar, role, phone, phone_direct, location, mobile_phone, active, manager, technical_manager, sales, technical, support_team, sales_admin, admin, business_finder, created_at, updated_at.

Examples:

curl -s -X GET "https://your-instance.bluerocktel.net/api/v1/users?filter[active]=true&filter[role]=3&sort=name&per_page=25" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

import requests

response = requests.get(
    "https://your-instance.bluerocktel.net/api/v1/users",
    params={
        "filter[active]": "true",
        "filter[role]": 3,
        "sort": "name",
        "per_page": 25,
    },
    headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
)
users = response.json()

use Illuminate\Support\Facades\Http;

$response = Http::withToken($token)
    ->acceptJson()
    ->get('https://your-instance.bluerocktel.net/api/v1/users', [
        'filter[active]' => 'true',
        'filter[role]' => 3,
        'sort' => 'name',
        'per_page' => 25,
    ]);

$users = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/users?filter[active]=true&filter[role]=3&sort=name&per_page=25",
  {
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
    },
  }
);
const users = await response.json();

POST /v1/users

Create a new user (standard resource route). Admin only.

Body (JSON): Standard user creation fields.

Response 201: Created user object.

GET /v1/users/{id}

Get a single user by ID. Includes teams and support_teams (if ticketing module enabled).

URL parameters:

Response 200: User object with teams. Response 404: Not found.

PUT /v1/users/{id}

Update a user.

URL parameters:

Response 200: Updated user object.

DELETE /v1/users/{id}

Delete a user.

Response 200: Success message.

POST /v1/impersonate

Impersonate another user (admin only).

Body (JSON):

Response 200: Impersonation session established.

Examples:

curl -s -X POST "https://your-instance.bluerocktel.net/api/v1/impersonate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"user_id": 5}'

import requests

response = requests.post(
    "https://your-instance.bluerocktel.net/api/v1/impersonate",
    json={"user_id": 5},
    headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
)
session = response.json()

$response = Http::withToken($token)
    ->acceptJson()
    ->post('https://your-instance.bluerocktel.net/api/v1/impersonate', [
        'user_id' => 5,
    ]);

$session = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/impersonate",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ user_id: 5 }),
  }
);
const session = await response.json();

GET /v1/impersonate

Leave impersonation and return to original user.

Response 200: Original session restored.

Teams

Base URL: /api/v1/teams

GET /v1/teams

List all teams ordered by name (no pagination).

Response 200: Array of all team objects.

POST /v1/teams

Create a new team.

Body (JSON): Validated via Team::keys().

Response 201: Created team object. Response 400: Validation error.

GET /v1/teams/{id}

Get a single team by ID with users relation.

URL parameters:

Response 200: Team object with users. Response 404: Not found.

PUT /v1/teams/{id}

Update a team.

Body (JSON): Validated via Team::keys().

Response 201: Updated team object. Response 400/404: Error.

DELETE /v1/teams/{id}

Delete a team.

Response 201: Success message. Response 404: Not found.