ApiKeys7

get/api/tenants/{tenantId}/api-keysLists all API keys for a tenant.
post/api/tenants/{tenantId}/api-keysCreates a new API key for the tenant. IMPORTANT: The full API key is only returned once during creation. Store it securely - you cannot retrieve it again.
get/api/tenants/{tenantId}/api-keys/{handle}Gets details of a specific API key.
delete/api/tenants/{tenantId}/api-keys/{handle}Revokes an API key permanently. The key can no longer be used and cannot be reactivated.
post/api/tenants/{tenantId}/api-keys/{handle}/suspendSuspends an API key (temporarily disables it). The key can be reactivated later.
post/api/tenants/{tenantId}/api-keys/{handle}/reactivateReactivates a suspended API key.
post/api/tenants/{tenantId}/api-keys/{handle}/regenerateRegenerates an API key (creates a new key and revokes the old one). IMPORTANT: The new API key is only returned once. Store it securely.

AppointmentConfirmation2

Appointments25

AppointmentTypes10

AutomatedEmailTemplates4

BillableItems5

Breeds5

BulkClientExport2

BulkPatientExport2

CareQueue2

CaseMilestones6

Cases5

ChatExport1

ClientAccount1

ClientCredit2

ClientExport3

Clients6

ClientStatement1

ClinicalAddenda2

ClinicConfig41

ClinicSettings2

Clocking6

Compliance1

ConsentDocuments2

DeaBooks10

DeaExport2

DentalCharts9

DeviceFormHandoffs4

DevicePush3

Devices5

DeviceSelf1

DiagnosisTerms1

DischargeSignOff2

Disclaimers7

DiscountCodes7

Drafts7

EdgePrinters3

EdgePrintJobs2

EmailVerification2

EmergencyIntake2

Erx6

Estimates30

ExamTemplates6

Expenses6

Featurebase2

FeatureFlags1

Flowboard10

FormHandoffs6

GroupCodes7

GroupVisits6

Health1

HomeAgain4

HospitalStays18

IntegrationCredentials18

InternalPrescribing1

InternalWidget1

Inventory25

InventoryApprovals5

InventoryLocations7

Invoices29

JourneyMilestones6

Kiosk4

LabPanels5

Labs21

LineItemNotes5

LocationClosures4

Locations11

Logos7

MedicationRequests7

MentorMetrics5

MessageAttachments4

Metrics31

NpsAnalytics3

NvsIntegration11

OnlineBookingReadiness1

Partners6

PatientGroups9

PatientMasses6

PatientProblems4

PatientRecordExport3

Patients21

Payments22

PaymentTokens5

Pep5

Pharmacies5

Phones2

PriceRules6

Printers7

PrintJobs4

PtoRequests6

PublicDevicePairing1

PublicEmailUnsubscribe2

PublicFileLinks2

PublicFormHandoffs1

PublicNps2

PublicPriceList5

PublicQuestionnaires4

PublicSmsConsent2

PurchaseOrders11

QiEvents9

QuestionnaireResponses7

Questionnaires18

RabiesTags10

RdvmPortal22

Recordings9

RecurringExpenses5

ReferralMessages2

Referrals20

Reminders14

Reports2

RetailItems11

Roles6

RoomDayAssignments3

RxGovernance26

SavedReports5

ScheduleItems10

ServiceCatalog5

Shifts5

ShiftSwaps8

SlotConfigurations6

SmsConsent9

Species5

StaffAvailability1

Subscriptions10

SurgicalRecords11

TagAssignments4

Tags5

TelnyxCallControl1

Templates16

TenantKnowledge5

TimeEntries5

Transparency3

Users14

Vaccinations12

VaccineAdministration3

VaccineCertificateRecords6

VaccineCertificates2

VaccineTypes5

Vendors6

Vitals2

VitalTypes6

Widget18

WidgetChatbot4

WorkItemRules5

WorkTasks13

ApiKeys

Creates a new API key for the tenant. IMPORTANT: The full API key is only returned once during creation. Store it securely - you cannot retrieve it again.

post/api/tenants/{tenantId}/api-keys

Request

Base URL
https://api.clinicos.vet/backend/business
Auth
HTTP bearer
TypeScript
https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/api/tenants/:tenantId/api-keys/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantIdstring required

The tenant ID.

Request body

namestring required

Human-readable name for the API key.

descriptionstring nullable

Optional description of what this key is used for.

scopesstring[] nullable

Scopes to grant. Defaults to ["read", "write"] if not specified.

expiresAtstring date-time nullable

Optional expiration date.

allowedIpAddressesstring[] nullable

Optional IP allowlist. If set, only requests from these IPs are allowed.

metadataobject nullable

Additional metadata.

Response

Created

apiKeystring required

keyHashstring required

keyPrefixstring required

tenantIdstring required

namestring required

scopesstring[] required

createdAtstring date-time required

Changes

No recorded changes to this operation across all 14 revisions of this API.