GET/api/v1/interactions/{id}

Product availabilityAlgaPSAAlgaDesk

Get an interaction

RBAC · interaction

Path parameters

idstring <uuid>Required

Response body

Success response 200 · schema InteractionSuccessV1

dataobjectRequired

tenantstring <uuid>Required

interaction_idstring <uuid>Required

type_idstring <uuid>Required

type_namestringRequiredNullable

iconstringRequiredNullable

contact_name_idstring <uuid>RequiredNullable

contact_namestringRequiredNullable

client_idstring <uuid>RequiredNullable

client_namestringRequiredNullable

user_idstring <uuid>Required

user_namestringRequiredNullable

ticket_idstring <uuid>RequiredNullable

project_idstring <uuid>RequiredNullable

opportunity_idstring <uuid>RequiredNullable

titlestringRequiredNullable

notesstringRequiredNullable

interaction_dateanyOfRequired

anyOf (option 1)string <date-time>

anyOf (option 2)string

start_timeanyOfRequired

anyOf (option 1)string <date-time>

anyOf (option 2)string

anyOf (option 3)null

end_timeanyOfRequired

anyOf (option 1)string <date-time>

anyOf (option 2)string

anyOf (option 3)null

durationintegerRequiredNullable

status_idstring <uuid>RequiredNullable

status_namestringRequiredNullable

is_status_closedbooleanRequiredNullable

visibilitystringRequired

Enum: internalclient_visible

metaobject

Response codes

200

Tenant interaction.

400

Validation or query parsing failure.

401

API key missing or invalid.

403

Interaction RBAC denied.

404

Interaction not found.

500

Unexpected controller or service failure.

GET /api/v1/interactions/{id}

cURL

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

TypeScript

const response = await fetch("https://algapsa.com/api/v1/interactions/{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/interactions/{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": {
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "interaction_id": "01HN2K7VRB9PQ3Y0000000000",
    "type_id": "01HN2K7VRB9PQ3Y0000000000",
    "type_name": "string",
    "icon": "string",
    "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
    "contact_name": "string",
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "client_name": "string",
    "user_id": "01HN2K7VRB9PQ3Y0000000000",
    "user_name": "string",
    "ticket_id": "01HN2K7VRB9PQ3Y0000000000",
    "project_id": "01HN2K7VRB9PQ3Y0000000000",
    "opportunity_id": "01HN2K7VRB9PQ3Y0000000000",
    "title": "string",
    "notes": "string",
    "interaction_date": "2026-04-18T15:22:14Z",
    "start_time": "2026-04-18T15:22:14Z",
    "end_time": "2026-04-18T15:22:14Z",
    "duration": 1,
    "status_id": "01HN2K7VRB9PQ3Y0000000000",
    "status_name": "string",
    "is_status_closed": false,
    "visibility": "internal"
  },
  "meta": {}
}