Get Integration Panel

Get one active integration panel and its stored instances.

GET https://api.sonorancad.com/v2/integration-panels/{panelKey}

Rate limit: 120 requests per minute per API key.

Get one active integration panel and its stored instances.

Path Parameters

Name

Type

Description

panelKey

string

Stable panel key.

Example Request

-- luarocks install sonoran.lua
local Sonoran = require("sonoran")
local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:getIntegrationPanelV2("example.fire-alarms")
print(response.success)

Use this tab from the server side of a FiveM resource. Never expose the API key to client scripts.

Sonoran.lua and Sonoran.js use the configured client exported by sonorancad. Sonoran.Net must read the CAD convars and create a client. Grant the resource access to the protected key with add_convar_permission your-resource-name read sonoran_apiKey.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()
local response = cad:getIntegrationPanelV2("example.fire-alarms")
print(response.success)

Sonoran.js

(async () => {
  const cad = exports["sonorancad"].getCadClient();
  const response = await cad.getIntegrationPanelV2('example.fire-alarms');
  console.log(response.success ? response.data : response.reason);
})();

Sonoran.Net

using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverId = int.TryParse(API.GetConvar("sonoran_serverId", "1"), out var parsed) ? parsed : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

var response = await sonoran.Cad.getIntegrationPanelV2("example.fire-alarms");

// npm install @sonoransoftware/sonoran.js
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.getIntegrationPanelV2('example.fire-alarms');
  console.log(response.success ? response.data : response.reason);
})();

# pip install Sonoran.py
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.getIntegrationPanelV2("example.fire-alarms")
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
using System.Collections.Generic;
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.getIntegrationPanelV2("example.fire-alarms");
Console.WriteLine(response.success ? response.data : response.reason);

Import this YAML into Postman with Import -> Raw text.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Get Integration Panel"
  version: "1.0.0"
servers:
  - url: "https://api.sonorancad.com"
paths:
  /v2/integration-panels/{panelKey}:
    get:
      summary: "Get Integration Panel"
      operationId: "getIntegrationPanel"
      security:
        - bearerAuth:
      parameters:
        - name: "panelKey"
          in: "path"
          required: true
          schema:
            type: "string"
          example: "example.fire-alarms"
      responses:
        200:
          description: "Panel definition and instances"
          content:
            application/json:
              schema:
                type: "object"
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request GET \\
  --url "https://api.sonorancad.com/v2/integration-panels/example.fire-alarms" \\
  --header "Authorization: Bearer YOUR_API_KEY" \\
  --header "Accept: application/json"

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "key": "example.fire-alarms",
  "name": "Fire Alarm",
  "definition": { "schemaVersion": 1, "name": "Fire Alarm", "body": [] },
  "updatedAt": "2026-08-25T18:00:00Z",
  "instances": [
    { "instanceKey": "default", "state": {}, "revision": 4, "updatedAt": "2026-08-25T18:01:00Z" }
  ]
}

PreviousList Integration Panels

NextSet Integration Panel

Last updated 9 days ago

Was this helpful?