Organisations and Brands

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

Model Properties

Organisation

Organisations

Base URL: /api/v1/organisations

Organisations are the top-level tenant entities in BlueRockTEL. There is typically only one or a few organisations per installation.

GET /v1/organisations

List all organisations.

Response 200: Array of organisation objects (organisation_resource collection, all records, no pagination).

Examples:

curl -s -X GET "https://your-instance.bluerocktel.net/api/v1/organisations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

import requests

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

use Illuminate\Support\Facades\Http;

$response = Http::withToken($token)
    ->acceptJson()
    ->get('https://your-instance.bluerocktel.net/api/v1/organisations');

$organisations = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/organisations",
  {
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
    },
  }
);
const organisations = await response.json();

GET /v1/organisations/{id}

Get a single organisation by ID.

URL parameters:

Response 200: Organisation object. Response 404: Not found.

PUT /v1/organisations/{id}

Update an organisation. Only fields listed in Organisation::updatable() are updated.

URL parameters:

Body (JSON): Validated via Organisation::attributes('common').

Response 201: Updated organisation object. Response 404: Not found. Response 422/500: Error.

Brands

Base URL: /api/v1/brands

Brands are sub-entities of organisations. Each customer file can be linked to a brand (affects invoice styling, logos, etc.).

Note: creating and deleting brands is not available via the API.

GET /v1/brands

List all brands.

Response 200: Array of all brand objects.

GET /v1/brands/{id}

Get a single brand by ID.

URL parameters:

Response 200: Brand object. Response 404: Not found.

PUT /v1/brands/{id}

Update a brand. Handles image uploads:

• logo: resized to max 500px width, stored on Swift and FTP disks.
• message_on_invoice: resized to 2126x709px, stored on Swift and FTP disks.

URL parameters:

Body (multipart/form-data or JSON): Validated via Brand::attributes('common').

Response 201: Updated brand object. Response 404: Not found. Response 422/500: Error.

Examples:

curl -s -X PUT "https://your-instance.bluerocktel.net/api/v1/brands/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -F "logo=@/path/to/logo.png" \
  -F "message_on_invoice=@/path/to/invoice-banner.png"

import requests

with open("logo.png", "rb") as logo, open("invoice-banner.png", "rb") as banner:
    response = requests.put(
        "https://your-instance.bluerocktel.net/api/v1/brands/1",
        files={
            "logo": ("logo.png", logo, "image/png"),
            "message_on_invoice": ("invoice-banner.png", banner, "image/png"),
        },
        headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
    )
brand = response.json()

$response = Http::withToken($token)
    ->acceptJson()
    ->attach('logo', file_get_contents('/path/to/logo.png'), 'logo.png')
    ->attach('message_on_invoice', file_get_contents('/path/to/invoice-banner.png'), 'invoice-banner.png')
    ->put('https://your-instance.bluerocktel.net/api/v1/brands/1');

$brand = $response->json();

const formData = new FormData();
formData.append("logo", logoFile);
formData.append("message_on_invoice", invoiceBannerFile);

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/brands/1",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
    },
    body: formData,
  }
);
const brand = await response.json();