GET/api/v1/boards/{id}

Get board by ID

Returns a single board by its UUID.

RBAC · ticket

Path parameters

idstring <uuid>Required

Board UUID.

Response body

Success response 200 · schema BoardEnvelope

dataobjectRequired

board_idstring <uuid>Required

board_namestringRequired

descriptionstringRequiredNullable

display_ordernumberRequired

is_defaultbooleanRequired

is_inactivebooleanRequired

category_typestringRequiredNullable

Enum: customitil

priority_typestringRequiredNullable

Enum: customitil

display_itil_impactbooleanRequiredNullable

display_itil_urgencybooleanRequiredNullable

default_assigned_tostring <uuid>RequiredNullable

inbound_reply_reopen_enabledboolean

inbound_reply_reopen_cutoff_hoursinteger

inbound_reply_reopen_status_idstring <uuid>Nullable

inbound_reply_ai_ack_suppression_enabledboolean

enable_live_ticket_timerbooleanRequiredNullable

tenantstring <uuid>Required

Response codes

200

Board returned successfully.

401

Authentication failed.

404

Board not found.

GET /api/v1/boards/{id}

cURL

curl -X GET "https://algapsa.com/api/v1/boards/{id}" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/boards/{id}", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/boards/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "board_id": "01HN2K7VRB9PQ3Y0000000000",
    "board_name": "string",
    "description": "string",
    "display_order": 0,
    "is_default": false,
    "is_inactive": false,
    "category_type": "custom",
    "priority_type": "custom",
    "display_itil_impact": false,
    "display_itil_urgency": false,
    "default_assigned_to": "01HN2K7VRB9PQ3Y0000000000",
    "inbound_reply_reopen_enabled": false,
    "inbound_reply_reopen_cutoff_hours": 1,
    "inbound_reply_reopen_status_id": "01HN2K7VRB9PQ3Y0000000000",
    "inbound_reply_ai_ack_suppression_enabled": false,
    "enable_live_ticket_timer": false,
    "tenant": "01HN2K7VRB9PQ3Y0000000000"
  }
}