PlatformXeDocs
Get API Key

Issues

SDK methods for the federated bug / support-ticket workflow.

The client.issues namespace creates and lists federated issues — bug reports and support tickets that traverse application boundaries. Available in TypeScript, Python, and Go SDKs.

SDKInstallNamespace
TypeScriptnpm install @caldera/platformxe-sdkclient.issues
Pythonpip install platformxeclient.issues
Gogo get github.com/calderax/platformxe-goclient.Issues

List issues

// All open issues for the calling org
const issues = await client.issues.list();

// Filter by app + status
const lettingsBugs = await client.issues.list({ app: 'lettings', status: 'OPEN' });

Create an issue

const created = await client.issues.create({
  app: 'lettings',
  reporterId: 'user_123',
  title: 'Booking confirmation email shows wrong nights',
  description: 'Booked 3 nights, email says 2. Check booking_confirmation template.',
  priority: 'HIGH',
  tags: ['email', 'template'],
  metadata: { bookingId: 'bk_abc', templateId: 'booking_confirmation' },
});
console.log(created.id); // 'iss_…'
created = client.issues.create(
    app="lettings",
    reporter_id="user_123",
    title="Booking confirmation email shows wrong nights",
    description="Booked 3 nights, email says 2.",
    priority="HIGH",
)

Fields

Issue record

FieldTypeDescription
idstringiss_<cuid>
organizationIdstringOwning tenant.
appstringSource app raising the issue.
reporterIdstringReporting user.
titlestring
descriptionstring
priority'LOW' | 'MEDIUM' | 'HIGH' | 'URGENT'Defaults to MEDIUM.
status'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CLOSED'
tagsstring[]
metadataRecord<string, unknown>Free-form structured context.
createdAt / updatedAtstringISO 8601 timestamps.

Scopes required

MethodScope
issues.list()issues:read
issues.create()issues:write