API REFERENCE · v0.1.0

The AlgaPSA REST API

A resource-oriented REST API returning JSON. HTTPS-only. API-key authenticated. 683 endpoints across 57 resources.

Each resource below links to its hub — workflows, examples, and its endpoints. Labels show which products support an endpoint: AlgaDesk, AlgaPSA, or both.

Base URL

algapsa.com

Resources

57

Endpoints

683

Spec

Service desk

Tickets API34 endpoints →GET/api/v1/ticketsAlgaPSAAlgaDeskList tickets POST/api/v1/ticketsAlgaPSAAlgaDeskCreate ticket GET/api/v1/tickets/{id}AlgaPSAAlgaDeskGet ticket PUT/api/v1/tickets/{id}AlgaPSAAlgaDeskUpdate ticket DELETE/api/v1/tickets/{id}AlgaPSAAlgaDeskDelete ticket GET/api/v1/tickets/{id}/assetsAlgaPSAList assets linked to a ticket POST/api/v1/tickets/{id}/assetsAlgaPSALink an asset to a ticket DELETE/api/v1/tickets/{id}/assets/{assetId}AlgaPSAUnlink an asset from a ticket PUT/api/v1/tickets/{id}/assignmentAlgaPSAAlgaDeskUpdate ticket assignment GET/api/v1/tickets/{id}/bundleAlgaPSAAlgaDeskGet ticket bundle POST/api/v1/tickets/{id}/bundleAlgaPSAAlgaDeskCreate ticket bundle DELETE/api/v1/tickets/{id}/bundleAlgaPSAAlgaDeskUnbundle ticket POST/api/v1/tickets/{id}/bundle/childrenAlgaPSAAlgaDeskAdd bundle children DELETE/api/v1/tickets/{id}/bundle/children/{childId}AlgaPSAAlgaDeskRemove bundle child POST/api/v1/tickets/{id}/bundle/promoteAlgaPSAAlgaDeskPromote bundle master PUT/api/v1/tickets/{id}/bundle/settingsAlgaPSAAlgaDeskUpdate ticket bundle settings GET/api/v1/tickets/{id}/commentsAlgaPSAAlgaDeskList ticket comments POST/api/v1/tickets/{id}/commentsAlgaPSAAlgaDeskAdd ticket comment PUT/api/v1/tickets/{id}/comments/{commentId}AlgaPSAAlgaDeskUpdate a ticket comment POST/api/v1/tickets/{id}/comments/{commentId}/reactionsAlgaPSAAlgaDeskToggle a comment reaction GET/api/v1/tickets/{id}/documentsAlgaPSAAlgaDeskList ticket documents POST/api/v1/tickets/{id}/documentsAlgaPSAAlgaDeskUpload a ticket document GET/api/v1/tickets/{id}/documents/{documentId}AlgaPSAAlgaDeskDownload a ticket document DELETE/api/v1/tickets/{id}/documents/{documentId}AlgaPSAAlgaDeskDelete a ticket document GET/api/v1/tickets/{id}/materialsAlgaPSAList ticket materials POST/api/v1/tickets/{id}/materialsAlgaPSAAdd a ticket material PUT/api/v1/tickets/{id}/statusAlgaPSAAlgaDeskUpdate ticket status GET/api/v1/tickets/{id}/time-entriesAlgaPSAList ticket time entries GET/api/v1/tickets/from-assetAlgaPSACreate ticket from asset (POST only)POST/api/v1/tickets/from-assetAlgaPSACreate ticket from asset GET/api/v1/tickets/prioritiesAlgaPSAAlgaDeskList ticket priorities GET/api/v1/tickets/searchAlgaPSAAlgaDeskSearch tickets GET/api/v1/tickets/statsAlgaPSAAlgaDeskGet ticket stats GET/api/v1/tickets/statusesAlgaPSAAlgaDeskList ticket statuses

Boards API5 endpoints →GET/api/v1/boardsAlgaPSAAlgaDeskList boards POST/api/v1/boardsAlgaPSAAlgaDeskCreate board GET/api/v1/boards/{id}AlgaPSAAlgaDeskGet board by ID PUT/api/v1/boards/{id}AlgaPSAAlgaDeskUpdate board DELETE/api/v1/boards/{id}AlgaPSAAlgaDeskDelete board

Statuses API5 endpoints →GET/api/v1/statusesAlgaPSAAlgaDeskList statuses POST/api/v1/statusesAlgaPSAAlgaDeskCreate status GET/api/v1/statuses/{id}AlgaPSAAlgaDeskGet status by ID PUT/api/v1/statuses/{id}AlgaPSAAlgaDeskUpdate status DELETE/api/v1/statuses/{id}AlgaPSAAlgaDeskDelete status

Priorities API2 endpoints →GET/api/v1/prioritiesAlgaPSAAlgaDeskList priorities GET/api/v1/priorities/{id}AlgaPSAAlgaDeskGet a priority

Categories API16 endpoints →GET/api/v1/categories/analyticsAlgaPSAGet category analytics POST/api/v1/categories/bulk/deleteAlgaPSABulk delete categories GET/api/v1/categories/searchAlgaPSASearch categories GET/api/v1/categories/serviceAlgaPSAList service categories POST/api/v1/categories/serviceAlgaPSACreate service category GET/api/v1/categories/service/{id}AlgaPSAGet service category PUT/api/v1/categories/service/{id}AlgaPSAUpdate service category DELETE/api/v1/categories/service/{id}AlgaPSADelete service category GET/api/v1/categories/ticketAlgaPSAList ticket categories POST/api/v1/categories/ticketAlgaPSACreate ticket category GET/api/v1/categories/ticket/{id}AlgaPSAGet ticket category PUT/api/v1/categories/ticket/{id}AlgaPSAUpdate ticket category DELETE/api/v1/categories/ticket/{id}AlgaPSADelete ticket category POST/api/v1/categories/ticket/moveAlgaPSAMove ticket category in hierarchy GET/api/v1/categories/ticket/treeAlgaPSAGet ticket category tree (implicit board id)GET/api/v1/categories/ticket/tree/{boardId}AlgaPSAGet ticket category tree by board

Service Types API2 endpoints →GET/api/v1/service-typesAlgaPSAList service types GET/api/v1/service-types/{id}AlgaPSAGet service type

Comments API1 endpoint →GET/api/v1/commentsAlgaPSAAlgaDeskComments API namespace root

Tags API19 endpoints →GET/api/v1/tagsAlgaPSAAlgaDeskList tags POST/api/v1/tagsAlgaPSAAlgaDeskCreate tag GET/api/v1/tags/{id}AlgaPSAAlgaDeskGet tag PUT/api/v1/tags/{id}AlgaPSAAlgaDeskUpdate tag DELETE/api/v1/tags/{id}AlgaPSAAlgaDeskDelete tag PUT/api/v1/tags/{id}/colorsAlgaPSAAlgaDeskUpdate tag colors PUT/api/v1/tags/{id}/textAlgaPSAAlgaDeskUpdate tag text GET/api/v1/tags/analyticsAlgaPSAAlgaDeskGet tag analytics POST/api/v1/tags/bulkAlgaPSAAlgaDeskBulk create tags DELETE/api/v1/tags/bulkAlgaPSAAlgaDeskBulk delete tags POST/api/v1/tags/bulk/mergeAlgaPSAAlgaDeskBulk merge tags POST/api/v1/tags/bulk/tagAlgaPSAAlgaDeskBulk tag entities DELETE/api/v1/tags/bulk/untagAlgaPSAAlgaDeskBulk untag entities DELETE/api/v1/tags/by-textAlgaPSAAlgaDeskDelete tags by text GET/api/v1/tags/cloudAlgaPSAAlgaDeskGet tag cloud GET/api/v1/tags/entity/{entityType}/{entityId}AlgaPSAAlgaDeskList tags for entity POST/api/v1/tags/entity/{entityType}/{entityId}AlgaPSAAlgaDeskAttach tags to entity DELETE/api/v1/tags/entity/{entityType}/{entityId}AlgaPSAAlgaDeskRemove tags from entity GET/api/v1/tags/searchAlgaPSAAlgaDeskSearch tags

Knowledge Base API12 endpoints →GET/api/v1/kb-articlesAlgaPSAAlgaDeskList knowledge base articles POST/api/v1/kb-articlesAlgaPSAAlgaDeskCreate a knowledge base article GET/api/v1/kb-articles/{id}AlgaPSAAlgaDeskGet a knowledge base article PUT/api/v1/kb-articles/{id}AlgaPSAAlgaDeskUpdate a knowledge base article DELETE/api/v1/kb-articles/{id}AlgaPSAAlgaDeskDelete a knowledge base article POST/api/v1/kb-articles/{id}/archiveAlgaPSAAlgaDeskArchive a knowledge base article GET/api/v1/kb-articles/{id}/contentAlgaPSAAlgaDeskGet KB article content as text PUT/api/v1/kb-articles/{id}/contentAlgaPSAAlgaDeskUpdate KB article content POST/api/v1/kb-articles/{id}/publishAlgaPSAAlgaDeskPublish a knowledge base article GET/api/v1/kb-articles/categoriesAlgaPSAAlgaDeskList KB article categories POST/api/v1/kb-articles/from-ticket/{ticketId}AlgaPSAAlgaDeskCreate a KB article from a ticket GET/api/v1/kb-articles/templatesAlgaPSAAlgaDeskList KB article templates

Clients & assets

Clients API9 endpoints →GET/api/v1/clientsAlgaPSAAlgaDeskList clients POST/api/v1/clientsAlgaPSAAlgaDeskCreate client GET/api/v1/clients/{id}AlgaPSAAlgaDeskGet client PUT/api/v1/clients/{id}AlgaPSAAlgaDeskUpdate client DELETE/api/v1/clients/{id}AlgaPSAAlgaDeskDelete client GET/api/v1/clients/{id}/contactsAlgaPSAAlgaDeskList contacts for client GET/api/v1/clients/{id}/locationsAlgaPSAAlgaDeskList client locations POST/api/v1/clients/{id}/locationsAlgaPSAAlgaDeskCreate client location GET/api/v1/clients/statsAlgaPSAAlgaDeskGet client stats

Contacts API8 endpoints →GET/api/v1/contactsAlgaPSAAlgaDeskList contacts POST/api/v1/contactsAlgaPSAAlgaDeskCreate contact GET/api/v1/contacts/{id}AlgaPSAAlgaDeskGet contact PUT/api/v1/contacts/{id}AlgaPSAAlgaDeskUpdate contact DELETE/api/v1/contacts/{id}AlgaPSAAlgaDeskDelete contact GET/api/v1/contacts/exportAlgaPSAAlgaDeskExport contacts GET/api/v1/contacts/searchAlgaPSAAlgaDeskSearch contacts GET/api/v1/contacts/statsAlgaPSAAlgaDeskGet contact stats

Assets API35 endpoints →GET/api/v1/assetsAlgaPSAList assets POST/api/v1/assetsAlgaPSACreate asset GET/api/v1/assets/{id}AlgaPSAGet asset details PUT/api/v1/assets/{id}AlgaPSAUpdate asset DELETE/api/v1/assets/{id}AlgaPSADelete asset GET/api/v1/assets/{id}/documentsAlgaPSAList asset document associations POST/api/v1/assets/{id}/documentsAlgaPSAAssociate document with asset GET/api/v1/assets/{id}/historyAlgaPSAList asset maintenance history GET/api/v1/assets/{id}/maintenanceAlgaPSAList asset maintenance schedules POST/api/v1/assets/{id}/maintenanceAlgaPSACreate asset maintenance schedule POST/api/v1/assets/{id}/maintenance/recordAlgaPSARecord asset maintenance GET/api/v1/assets/{id}/notesAlgaPSAGet asset notes PUT/api/v1/assets/{id}/notesAlgaPSAUpdate asset notes DELETE/api/v1/assets/{id}/notesAlgaPSADelete asset notes GET/api/v1/assets/{id}/relationshipsAlgaPSAList asset relationships POST/api/v1/assets/{id}/relationshipsAlgaPSACreate asset relationship GET/api/v1/assets/{id}/rmmAlgaPSAGet cached RMM data POST/api/v1/assets/{id}/rmm/rebootAlgaPSAReboot device via RMM POST/api/v1/assets/{id}/rmm/refreshAlgaPSARefresh RMM data for device GET/api/v1/assets/{id}/rmm/remote-controlAlgaPSAGet remote-control session URL POST/api/v1/assets/{id}/rmm/scriptAlgaPSARun a script via RMM GET/api/v1/assets/{id}/softwareAlgaPSAList asset software inventory GET/api/v1/assets/{id}/summaryAlgaPSAGet asset summary metrics GET/api/v1/assets/{id}/ticketsAlgaPSAList tickets linked to an asset POST/api/v1/assets/{id}/ticketsAlgaPSALink a ticket to an asset DELETE/api/v1/assets/{id}/tickets/{ticketId}AlgaPSAUnlink a ticket from an asset PUT/api/v1/assets/bulk-statusAlgaPSABulk update asset status PUT/api/v1/assets/bulk-updateAlgaPSABulk update assets DELETE/api/v1/assets/documents/{associationId}AlgaPSARemove asset document association GET/api/v1/assets/exportAlgaPSAExport assets PUT/api/v1/assets/maintenance/{scheduleId}AlgaPSAUpdate asset maintenance schedule DELETE/api/v1/assets/maintenance/{scheduleId}AlgaPSADelete asset maintenance schedule DELETE/api/v1/assets/relationships/{relationshipId}AlgaPSADelete asset relationship GET/api/v1/assets/searchAlgaPSASearch assets GET/api/v1/assets/statsAlgaPSAGet asset statistics

Software API1 endpoint →GET/api/v1/software/searchAlgaPSASearch software across the fleet

Time & projects

Projects API34 endpoints →GET/api/projectsAlgaPSAList projects GET/api/projects/templatesAlgaPSAList project templates POST/api/projects/templatesAlgaPSACreate project template GET/api/projects/templates/{templateId}AlgaPSAGet a project template PATCH/api/projects/templates/{templateId}AlgaPSAUpdate project template DELETE/api/projects/templates/{templateId}AlgaPSADelete a project template POST/api/projects/templates/{templateId}/applyAlgaPSACreate project from template POST/api/projects/templates/{templateId}/duplicateAlgaPSADuplicate project template GET/api/projects/templates/categoriesAlgaPSAList project template categories GET/api/v1/projectsAlgaPSAList projects POST/api/v1/projectsAlgaPSACreate project GET/api/v1/projects/{id}AlgaPSAGet project PUT/api/v1/projects/{id}AlgaPSAUpdate project DELETE/api/v1/projects/{id}AlgaPSADelete project GET/api/v1/projects/{id}/phasesAlgaPSAList project phases POST/api/v1/projects/{id}/phasesAlgaPSACreate project phase PUT/api/v1/projects/{id}/phases/{phaseId}AlgaPSAUpdate project phase DELETE/api/v1/projects/{id}/phases/{phaseId}AlgaPSADelete project phase GET/api/v1/projects/{id}/phases/{phaseId}/tasksAlgaPSAList project phase tasks POST/api/v1/projects/{id}/phases/{phaseId}/tasksAlgaPSACreate project phase task GET/api/v1/projects/{id}/task-status-mappingsAlgaPSAList project task status mappings GET/api/v1/projects/{id}/tasksAlgaPSAList project tasks GET/api/v1/projects/{id}/ticketsAlgaPSAList project tickets PUT/api/v1/projects/bulk-assignAlgaPSABulk assign projects PUT/api/v1/projects/bulk-statusAlgaPSABulk update project status PUT/api/v1/projects/bulk-updateAlgaPSABulk update projects GET/api/v1/projects/exportAlgaPSAExport projects GET/api/v1/projects/searchAlgaPSASearch projects GET/api/v1/projects/statsAlgaPSAGet project stats GET/api/v1/projects/tasks/{taskId}AlgaPSAGet project task PUT/api/v1/projects/tasks/{taskId}AlgaPSAUpdate project task DELETE/api/v1/projects/tasks/{taskId}AlgaPSADelete project task GET/api/v1/projects/tasks/{taskId}/checklistAlgaPSAList task checklist items POST/api/v1/projects/tasks/{taskId}/checklistAlgaPSACreate task checklist item

Activities API9 endpoints →GET/api/v1/activitiesAlgaPSAList user activities POST/api/v1/activities/ad-hocAlgaPSACreate ad-hoc activity PATCH/api/v1/activities/ad-hoc/{id}AlgaPSAUpdate ad-hoc activity DELETE/api/v1/activities/ad-hoc/{id}AlgaPSADelete ad-hoc activity POST/api/v1/activities/ad-hoc/{id}/doneAlgaPSAToggle ad-hoc activity done GET/api/v1/activities/groupsAlgaPSAList custom activity groups PATCH/api/v1/activities/groups/{groupId}/itemsAlgaPSAReorder activities within a group POST/api/v1/activities/groups/itemsAlgaPSAMove an activity into a group DELETE/api/v1/activities/groups/itemsAlgaPSARemove an activity from its group

Time Entries API17 endpoints →GET/api/v1/time-entriesAlgaPSAList time entries POST/api/v1/time-entriesAlgaPSACreate time entry GET/api/v1/time-entries/{id}AlgaPSAGet time entry PUT/api/v1/time-entries/{id}AlgaPSAUpdate time entry DELETE/api/v1/time-entries/{id}AlgaPSADelete time entry GET/api/v1/time-entries/active-sessionAlgaPSAGet active tracking session POST/api/v1/time-entries/approveAlgaPSAApprove time entries POST/api/v1/time-entries/bulkAlgaPSABulk create time entries PUT/api/v1/time-entries/bulkAlgaPSABulk update time entries DELETE/api/v1/time-entries/bulkAlgaPSABulk delete time entries GET/api/v1/time-entries/exportAlgaPSAExport time entries POST/api/v1/time-entries/request-changesAlgaPSARequest time entry changes GET/api/v1/time-entries/searchAlgaPSASearch time entries POST/api/v1/time-entries/start-trackingAlgaPSAStart time tracking GET/api/v1/time-entries/statsAlgaPSAGet time entry stats POST/api/v1/time-entries/stop-tracking/{sessionId}AlgaPSAStop time tracking GET/api/v1/time-entries/templatesAlgaPSAList time entry templates

Timesheets API17 endpoints →GET/api/v1/time-sheetsAlgaPSAList time sheets POST/api/v1/time-sheetsAlgaPSACreate time sheet GET/api/v1/time-sheets/{id}AlgaPSAGet time sheet PUT/api/v1/time-sheets/{id}AlgaPSAUpdate time sheet DELETE/api/v1/time-sheets/{id}AlgaPSADelete time sheet POST/api/v1/time-sheets/{id}/add-entryAlgaPSAAdd time sheet entry POST/api/v1/time-sheets/{id}/approveAlgaPSAApprove time sheet GET/api/v1/time-sheets/{id}/entriesAlgaPSAList time sheet entries POST/api/v1/time-sheets/{id}/rejectAlgaPSAReject time sheet DELETE/api/v1/time-sheets/{id}/remove-entryAlgaPSARemove time sheet entry POST/api/v1/time-sheets/{id}/request-changesAlgaPSARequest time sheet changes POST/api/v1/time-sheets/{id}/reverse-approvalAlgaPSAReverse time sheet approval POST/api/v1/time-sheets/{id}/submitAlgaPSASubmit time sheet GET/api/v1/time-sheets/{id}/summaryAlgaPSAGet time sheet summary POST/api/v1/time-sheets/bulkAlgaPSABulk time sheet operation GET/api/v1/time-sheets/exportAlgaPSAExport time sheets GET/api/v1/time-sheets/searchAlgaPSASearch time sheets

Time Periods API8 endpoints →GET/api/v1/time-periodsAlgaPSAList time periods POST/api/v1/time-periodsAlgaPSACreate time period GET/api/v1/time-periods/{id}AlgaPSAGet time period PUT/api/v1/time-periods/{id}AlgaPSAUpdate time period DELETE/api/v1/time-periods/{id}AlgaPSADelete time period POST/api/v1/time-periods/{id}/closeAlgaPSAClose time period POST/api/v1/time-periods/{id}/reopenAlgaPSAReopen time period GET/api/v1/time-periods/currentAlgaPSAGet current time period

Schedules API7 endpoints →GET/api/v1/schedulesAlgaPSAList schedule entries POST/api/v1/schedulesAlgaPSACreate schedule entry GET/api/v1/schedules/{id}AlgaPSAGet schedule entry PUT/api/v1/schedules/{id}AlgaPSAUpdate schedule entry DELETE/api/v1/schedules/{id}AlgaPSADelete schedule entry GET/api/v1/schedules/{id}/conflictsAlgaPSAGet schedule conflicts GET/api/v1/schedules/searchAlgaPSASearch schedules

Billing & contracts

Invoices API31 endpoints →GET/api/v1/invoicesAlgaPSAList invoices POST/api/v1/invoicesAlgaPSACreate invoice GET/api/v1/invoices/{id}AlgaPSAGet invoice by id PUT/api/v1/invoices/{id}AlgaPSAUpdate invoice DELETE/api/v1/invoices/{id}AlgaPSADelete invoice POST/api/v1/invoices/{id}/approveAlgaPSAApprove invoice POST/api/v1/invoices/{id}/creditAlgaPSAApply credit to invoice POST/api/v1/invoices/{id}/duplicateAlgaPSADuplicate invoice POST/api/v1/invoices/{id}/finalizeAlgaPSAFinalize invoice GET/api/v1/invoices/{id}/itemsAlgaPSAList invoice items POST/api/v1/invoices/{id}/paymentAlgaPSARecord invoice payment GET/api/v1/invoices/{id}/pdfAlgaPSADownload invoice PDF POST/api/v1/invoices/{id}/pdfAlgaPSAGenerate and download invoice PDF POST/api/v1/invoices/{id}/rejectAlgaPSAReject invoice POST/api/v1/invoices/{id}/sendAlgaPSASend invoice POST/api/v1/invoices/{id}/taxAlgaPSACalculate invoice tax GET/api/v1/invoices/{id}/transactionsAlgaPSAList invoice transactions GET/api/v1/invoices/analyticsAlgaPSAGet invoice analytics POST/api/v1/invoices/bulkAlgaPSABulk update invoice status POST/api/v1/invoices/bulk/creditAlgaPSABulk apply invoice credits POST/api/v1/invoices/bulk/deleteAlgaPSABulk delete invoices POST/api/v1/invoices/bulk/sendAlgaPSABulk send invoices GET/api/v1/invoices/exportAlgaPSAExport invoices POST/api/v1/invoices/generateAlgaPSAGenerate recurring invoice POST/api/v1/invoices/manualAlgaPSACreate manual invoice POST/api/v1/invoices/previewAlgaPSAPreview recurring invoice GET/api/v1/invoices/recurringAlgaPSAList recurring invoice templates POST/api/v1/invoices/recurringAlgaPSACreate recurring invoice template PUT/api/v1/invoices/recurring/{id}AlgaPSAUpdate recurring invoice template DELETE/api/v1/invoices/recurring/{id}AlgaPSADelete recurring invoice template GET/api/v1/invoices/searchAlgaPSASearch invoices

Quotes API21 endpoints →GET/api/v1/quotesAlgaPSAList quotes POST/api/v1/quotesAlgaPSACreate quote GET/api/v1/quotes/{id}AlgaPSAGet quote PUT/api/v1/quotes/{id}AlgaPSAUpdate quote DELETE/api/v1/quotes/{id}AlgaPSADelete quote GET/api/v1/quotes/{id}/activitiesAlgaPSAList quote activities POST/api/v1/quotes/{id}/approveAlgaPSAApprove quote POST/api/v1/quotes/{id}/convertAlgaPSAConvert quote GET/api/v1/quotes/{id}/convert/previewAlgaPSAPreview quote conversion GET/api/v1/quotes/{id}/itemsAlgaPSAList quote items POST/api/v1/quotes/{id}/itemsAlgaPSAAdd quote item PUT/api/v1/quotes/{id}/items/{itemId}AlgaPSAUpdate quote item DELETE/api/v1/quotes/{id}/items/{itemId}AlgaPSADelete quote item POST/api/v1/quotes/{id}/items/reorderAlgaPSAReorder quote items POST/api/v1/quotes/{id}/remindAlgaPSASend quote reminder POST/api/v1/quotes/{id}/request-changesAlgaPSARequest quote changes POST/api/v1/quotes/{id}/resendAlgaPSAResend quote GET/api/v1/quotes/{id}/revisionsAlgaPSAList quote revisions POST/api/v1/quotes/{id}/revisionsAlgaPSACreate quote revision POST/api/v1/quotes/{id}/sendAlgaPSASend quote POST/api/v1/quotes/{id}/submit-for-approvalAlgaPSASubmit quote for approval

Financial API30 endpoints →GET/api/v1/financialAlgaPSAFinancial API namespace root POST/api/v1/financial/billing/calculateAlgaPSACalculate client billing charges GET/api/v1/financial/billing/payment-termsAlgaPSAList billing payment terms POST/api/v1/financial/bulk/creditsAlgaPSARun bulk credit operation POST/api/v1/financial/bulk/invoicesAlgaPSARun bulk invoice operation POST/api/v1/financial/bulk/transactionsAlgaPSARun bulk transaction operation GET/api/v1/financial/creditsAlgaPSAList credit balances and records POST/api/v1/financial/credits/applyAlgaPSAApply credit to invoice POST/api/v1/financial/credits/prepaymentAlgaPSACreate prepayment invoice POST/api/v1/financial/credits/transferAlgaPSATransfer credit between clients POST/api/v1/financial/credits/validateAlgaPSAValidate client credit balance GET/api/v1/financial/invoicesAlgaPSAList invoices POST/api/v1/financial/invoices/{id}/finalizeAlgaPSAFinalize financial invoice (maps to generic update)POST/api/v1/financial/invoices/{id}/itemsAlgaPSAAdd financial invoice item (maps to generic create)GET/api/v1/financial/payment-methodsAlgaPSAList payment methods POST/api/v1/financial/payment-methodsAlgaPSACreate payment method GET/api/v1/financial/payment-methods/{id}AlgaPSAGet payment method by id (transaction get wiring)PUT/api/v1/financial/payment-methods/{id}AlgaPSAUpdate payment method by id (transaction update wiring)DELETE/api/v1/financial/payment-methods/{id}AlgaPSADelete payment method by id (transaction delete wiring)POST/api/v1/financial/reconciliation/{id}/resolveAlgaPSAResolve reconciliation report POST/api/v1/financial/reconciliation/runAlgaPSARun financial reconciliation GET/api/v1/financial/reports/agingAlgaPSAGet aging report GET/api/v1/financial/reports/analyticsAlgaPSAGet financial analytics GET/api/v1/financial/reports/balanceAlgaPSAGet account balance report POST/api/v1/financial/tax/calculateAlgaPSACalculate financial tax GET/api/v1/financial/tax/ratesAlgaPSAList financial tax rates (transaction list wiring)GET/api/v1/financial/transactionsAlgaPSAList financial transactions POST/api/v1/financial/transactionsAlgaPSACreate financial transaction GET/api/v1/financial/transactions/{id}AlgaPSAGet financial transaction by id PUT/api/v1/financial/transactions/{id}AlgaPSAUpdate financial transaction

Contracts API4 endpoints →GET/api/v1/contractsAlgaPSAList contracts POST/api/v1/contractsAlgaPSACreate contract POST/api/v1/contracts/{contractId}/contract-linesAlgaPSAAttach contract line DELETE/api/v1/contracts/{contractId}/contract-lines/{contractLineId}AlgaPSADetach contract line

Contract Lines API24 endpoints →GET/api/v1/contract-linesAlgaPSAList contract lines POST/api/v1/contract-linesAlgaPSACreate contract line GET/api/v1/contract-lines/{id}AlgaPSAGet contract line PUT/api/v1/contract-lines/{id}AlgaPSAUpdate contract line DELETE/api/v1/contract-lines/{id}AlgaPSADelete contract line PUT/api/v1/contract-lines/{id}/activationAlgaPSASet contract line activation GET/api/v1/contract-lines/{id}/analyticsAlgaPSAGet contract line analytics POST/api/v1/contract-lines/{id}/copyAlgaPSACopy contract line GET/api/v1/contract-lines/{id}/fixed-configAlgaPSAGet fixed contract line config PUT/api/v1/contract-lines/{id}/fixed-configAlgaPSAUpsert fixed contract line config GET/api/v1/contract-lines/{id}/servicesAlgaPSAList contract line services POST/api/v1/contract-lines/{id}/servicesAlgaPSAAdd service to contract line GET/api/v1/contract-lines/{id}/services/{serviceId}AlgaPSAGet contract line service details PUT/api/v1/contract-lines/{id}/services/{serviceId}AlgaPSAUpdate contract line service DELETE/api/v1/contract-lines/{id}/services/{serviceId}AlgaPSARemove service from contract line GET/api/v1/contract-lines/{id}/usage-metricsAlgaPSAGet contract line usage metrics POST/api/v1/contract-lines/bulkAlgaPSABulk create contract lines PUT/api/v1/contract-lines/bulkAlgaPSABulk update contract lines DELETE/api/v1/contract-lines/bulkAlgaPSABulk delete contract lines POST/api/v1/contract-lines/bulk/add-servicesAlgaPSABulk add services to contract line POST/api/v1/contract-lines/bulk/createAlgaPSABulk create contract lines (explicit route)DELETE/api/v1/contract-lines/bulk/deleteAlgaPSABulk delete contract lines (explicit route)DELETE/api/v1/contract-lines/bulk/remove-servicesAlgaPSABulk remove services from contract line PUT/api/v1/contract-lines/bulk/updateAlgaPSABulk update contract lines (explicit route)

Contract Line Templates API2 endpoints →POST/api/v1/contract-line-templatesAlgaPSACreate contract line template POST/api/v1/contract-line-templates/{id}/create-contract-lineAlgaPSACreate contract line from template

Client Contract Lines API3 endpoints →GET/api/v1/client-contract-linesAlgaPSAList client contract lines POST/api/v1/client-contract-linesAlgaPSAAssign contract line to client DELETE/api/v1/client-contract-lines/{id}AlgaPSAUnassign contract line from client

Products API5 endpoints →GET/api/v1/productsAlgaPSAList products POST/api/v1/productsAlgaPSACreate product GET/api/v1/products/{id}AlgaPSAGet product PUT/api/v1/products/{id}AlgaPSAUpdate product DELETE/api/v1/products/{id}AlgaPSADelete product

Services API5 endpoints →GET/api/v1/servicesAlgaPSAList services POST/api/v1/servicesAlgaPSACreate service GET/api/v1/services/{id}AlgaPSAGet service PUT/api/v1/services/{id}AlgaPSAUpdate service DELETE/api/v1/services/{id}AlgaPSADelete service

Billing API3 endpoints →GET/api/billing/licence-countAlgaPSAGet tenant licence usage POST/api/billing/licence-countAlgaPSAUpdate tenant licensed user count GET/api/v1/billingAlgaPSABilling API namespace root

Billing Analytics API1 endpoint →GET/api/v1/billing-analytics/overviewAlgaPSAGet billing overview analytics

Accounting Exports API4 endpoints →GET/api/v1/accounting-exports/{batchId}/downloadAlgaPSADownload an accounting export batch GET/api/v1/accounting-exports/xero-csv/client-exportAlgaPSAExport clients as Xero Contacts CSV POST/api/v1/accounting-exports/xero-csv/client-importAlgaPSAImport Xero Contacts CSV POST/api/v1/accounting-exports/xero-csv/tax-importAlgaPSAImport Xero invoice tax CSV

Automation & integrations

Workflow Definitions API11 endpoints →GET/api/workflow-definitionsAlgaPSAList workflow definitions POST/api/workflow-definitionsAlgaPSACreate workflow definition GET/api/workflow-definitions/{workflowId}/{version}AlgaPSAGet a workflow version PUT/api/workflow-definitions/{workflowId}/{version}AlgaPSAUpdate workflow draft definition POST/api/workflow-definitions/{workflowId}/{version}/publishAlgaPSAPublish a workflow version GET/api/workflow-definitions/{workflowId}/auditAlgaPSAGet workflow audit log GET/api/workflow-definitions/{workflowId}/audit/exportAlgaPSAExport workflow audit log GET/api/workflow-definitions/{workflowId}/exportAlgaPSAExport a workflow definition PUT/api/workflow-definitions/{workflowId}/metadataAlgaPSAUpdate workflow metadata GET/api/workflow-definitions/{workflowId}/versionsAlgaPSAList workflow versions POST/api/workflow-definitions/importAlgaPSAImport a v1 workflow bundle

Workflow Runs API18 endpoints →GET/api/workflow-runsAlgaPSAList workflow runs POST/api/workflow-runsAlgaPSAStart a workflow run GET/api/workflow-runs/{runId}AlgaPSAGet a workflow run GET/api/workflow-runs/{runId}/auditAlgaPSAGet workflow run audit log GET/api/workflow-runs/{runId}/audit/exportAlgaPSAExport workflow run audit log POST/api/workflow-runs/{runId}/cancelAlgaPSACancel a workflow run GET/api/workflow-runs/{runId}/exportAlgaPSAExport a workflow run POST/api/workflow-runs/{runId}/replayAlgaPSAReplay a workflow run POST/api/workflow-runs/{runId}/requeueAlgaPSARequeue a workflow run POST/api/workflow-runs/{runId}/resumeAlgaPSAResume a workflow run POST/api/workflow-runs/{runId}/retryAlgaPSARetry a failed workflow run GET/api/workflow-runs/{runId}/stepsAlgaPSAGet workflow run steps GET/api/workflow-runs/{runId}/summaryAlgaPSAGet workflow run summary GET/api/workflow-runs/{runId}/timelineAlgaPSAGet workflow run timeline GET/api/workflow-runs/dead-letterAlgaPSAList dead-lettered runs GET/api/workflow-runs/exportAlgaPSAExport workflow runs GET/api/workflow-runs/latestAlgaPSAGet latest workflow runs GET/api/workflow-runs/summaryAlgaPSAGet workflow runs summary

Workflow Events API9 endpoints →GET/api/workflow/eventsAlgaPSAList workflow events POST/api/workflow/eventsAlgaPSASubmit a workflow event GET/api/workflow/events/{eventId}AlgaPSAGet a workflow event GET/api/workflow/events/exportAlgaPSAExport workflow events GET/api/workflow/events/summaryAlgaPSAGet workflow events summary GET/api/workflow/registry/actionsAlgaPSAList workflow registry actions GET/api/workflow/registry/designer-catalogAlgaPSAGet the workflow designer action catalog GET/api/workflow/registry/nodesAlgaPSAList workflow registry node types GET/api/workflow/registry/schemas/{schemaRef}AlgaPSAGet a workflow schema by ref

Automation API18 endpoints →GET/api/v1/automation/executionsAlgaPSAList automation executions GET/api/v1/automation/executions/{id}AlgaPSAGet automation execution POST/api/v1/automation/executions/{id}/retryAlgaPSARetry automation execution GET/api/v1/automation/metaAlgaPSAGet automation metadata GET/api/v1/automation/performanceAlgaPSAGet automation performance metrics GET/api/v1/automation/rulesAlgaPSAList automation rules POST/api/v1/automation/rulesAlgaPSACreate automation rule GET/api/v1/automation/rules/{id}AlgaPSAGet automation rule PUT/api/v1/automation/rules/{id}AlgaPSAUpdate automation rule DELETE/api/v1/automation/rules/{id}AlgaPSADelete automation rule POST/api/v1/automation/rules/{id}/executeAlgaPSAExecute automation rule manually POST/api/v1/automation/rules/bulk-executeAlgaPSABulk execute automation rules POST/api/v1/automation/rules/bulk-statusAlgaPSABulk update automation rule status GET/api/v1/automation/statisticsAlgaPSAGet automation statistics GET/api/v1/automation/templatesAlgaPSAList automation templates POST/api/v1/automation/templatesAlgaPSACreate automation template from rule GET/api/v1/automation/templates/{id}AlgaPSAGet automation template POST/api/v1/automation/templates/{id}/useAlgaPSACreate automation rule from template

Integrations API40 endpoints →GET/api/integrations/qbo/callbackAlgaPSAHandle QuickBooks Online OAuth callback GET/api/integrations/qbo/connectAlgaPSAStart QuickBooks Online OAuth flow GET/api/integrations/qbo/statusAlgaPSAQuickBooks Online status route unavailable GET/api/v1/integrations/quickbooks/accountsAlgaPSAGet QuickBooks chart of accounts GET/api/v1/integrations/quickbooks/accounts/mappingsAlgaPSAList account mappings PUT/api/v1/integrations/quickbooks/accounts/mappingsAlgaPSAConfigure account mappings POST/api/v1/integrations/quickbooks/connection/refreshAlgaPSARefresh QuickBooks connection tokens GET/api/v1/integrations/quickbooks/connection/statusAlgaPSAGet QuickBooks connection status POST/api/v1/integrations/quickbooks/connection/testAlgaPSARun QuickBooks connection test GET/api/v1/integrations/quickbooks/customers/mappingsAlgaPSAList customer mappings DELETE/api/v1/integrations/quickbooks/customers/mappings/{mapping_id}AlgaPSADelete customer mapping POST/api/v1/integrations/quickbooks/customers/syncAlgaPSASync customers POST/api/v1/integrations/quickbooks/diagnosticsAlgaPSARun QuickBooks diagnostics GET/api/v1/integrations/quickbooks/healthAlgaPSAGet integration health GET/api/v1/integrations/quickbooks/health/configAlgaPSAGet health monitoring config PUT/api/v1/integrations/quickbooks/health/configAlgaPSAUpdate health monitoring config POST/api/v1/integrations/quickbooks/invoices/exportAlgaPSAExport invoices to QuickBooks POST/api/v1/integrations/quickbooks/invoices/importAlgaPSAImport invoices from QuickBooks GET/api/v1/integrations/quickbooks/itemsAlgaPSAList QuickBooks items GET/api/v1/integrations/quickbooks/mappingsAlgaPSAList data mappings POST/api/v1/integrations/quickbooks/mappingsAlgaPSACreate data mapping GET/api/v1/integrations/quickbooks/mappings/{mapping_id}AlgaPSAGet data mapping by id PUT/api/v1/integrations/quickbooks/mappings/{mapping_id}AlgaPSAUpdate data mapping DELETE/api/v1/integrations/quickbooks/mappings/{mapping_id}AlgaPSADelete data mapping POST/api/v1/integrations/quickbooks/oauth/callbackAlgaPSAHandle QuickBooks OAuth callback payload DELETE/api/v1/integrations/quickbooks/oauth/disconnectAlgaPSADisconnect QuickBooks OAuth POST/api/v1/integrations/quickbooks/oauth/initiateAlgaPSAInitiate QuickBooks OAuth flow GET/api/v1/integrations/quickbooks/payment-methodsAlgaPSAList QuickBooks payment methods POST/api/v1/integrations/quickbooks/payments/syncAlgaPSASync payments POST/api/v1/integrations/quickbooks/sync/{sync_id}/cancelAlgaPSACancel sync operation POST/api/v1/integrations/quickbooks/sync/{sync_id}/retryAlgaPSARetry sync operation POST/api/v1/integrations/quickbooks/sync/bulkAlgaPSARun bulk QuickBooks sync POST/api/v1/integrations/quickbooks/sync/fullAlgaPSARun full QuickBooks sync GET/api/v1/integrations/quickbooks/sync/historyAlgaPSAList sync history GET/api/v1/integrations/quickbooks/sync/statusAlgaPSAGet current sync status GET/api/v1/integrations/quickbooks/sync/status/{sync_id}AlgaPSAGet sync status by id GET/api/v1/integrations/quickbooks/tax-codesAlgaPSAList QuickBooks tax codes GET/api/v1/integrations/quickbooks/tax-codes/mappingsAlgaPSAList tax mappings PUT/api/v1/integrations/quickbooks/tax-codes/mappingsAlgaPSAConfigure tax mappings GET/api/v1/integrations/quickbooks/termsAlgaPSAList QuickBooks terms

QuickBooks API37 endpoints →GET/api/v1/quickbooks/accountsAlgaPSAGet QuickBooks chart of accounts GET/api/v1/quickbooks/accounts/mappingsAlgaPSAList account mappings PUT/api/v1/quickbooks/accounts/mappingsAlgaPSAConfigure account mappings POST/api/v1/quickbooks/connection/refreshAlgaPSARefresh QuickBooks connection tokens GET/api/v1/quickbooks/connection/statusAlgaPSAGet QuickBooks connection status POST/api/v1/quickbooks/connection/testAlgaPSARun QuickBooks connection test GET/api/v1/quickbooks/customers/mappingsAlgaPSAList customer mappings DELETE/api/v1/quickbooks/customers/mappings/{mapping_id}AlgaPSADelete customer mapping POST/api/v1/quickbooks/customers/syncAlgaPSASync customers POST/api/v1/quickbooks/diagnosticsAlgaPSARun QuickBooks diagnostics GET/api/v1/quickbooks/healthAlgaPSAGet integration health GET/api/v1/quickbooks/health/configAlgaPSAGet health monitoring config PUT/api/v1/quickbooks/health/configAlgaPSAUpdate health monitoring config POST/api/v1/quickbooks/invoices/exportAlgaPSAExport invoices to QuickBooks POST/api/v1/quickbooks/invoices/importAlgaPSAImport invoices from QuickBooks GET/api/v1/quickbooks/itemsAlgaPSAList QuickBooks items GET/api/v1/quickbooks/mappingsAlgaPSAList data mappings POST/api/v1/quickbooks/mappingsAlgaPSACreate data mapping GET/api/v1/quickbooks/mappings/{mapping_id}AlgaPSAGet data mapping by id PUT/api/v1/quickbooks/mappings/{mapping_id}AlgaPSAUpdate data mapping DELETE/api/v1/quickbooks/mappings/{mapping_id}AlgaPSADelete data mapping POST/api/v1/quickbooks/oauth/callbackAlgaPSAHandle QuickBooks OAuth callback payload DELETE/api/v1/quickbooks/oauth/disconnectAlgaPSADisconnect QuickBooks OAuth POST/api/v1/quickbooks/oauth/initiateAlgaPSAInitiate QuickBooks OAuth flow GET/api/v1/quickbooks/payment-methodsAlgaPSAList QuickBooks payment methods POST/api/v1/quickbooks/payments/syncAlgaPSASync payments POST/api/v1/quickbooks/sync/{sync_id}/cancelAlgaPSACancel sync operation POST/api/v1/quickbooks/sync/{sync_id}/retryAlgaPSARetry sync operation POST/api/v1/quickbooks/sync/bulkAlgaPSARun bulk QuickBooks sync POST/api/v1/quickbooks/sync/fullAlgaPSARun full QuickBooks sync GET/api/v1/quickbooks/sync/historyAlgaPSAList sync history GET/api/v1/quickbooks/sync/statusAlgaPSAGet current sync status GET/api/v1/quickbooks/sync/status/{sync_id}AlgaPSAGet sync status by id GET/api/v1/quickbooks/tax-codesAlgaPSAList QuickBooks tax codes GET/api/v1/quickbooks/tax-codes/mappingsAlgaPSAList tax mappings PUT/api/v1/quickbooks/tax-codes/mappingsAlgaPSAConfigure tax mappings GET/api/v1/quickbooks/termsAlgaPSAList QuickBooks terms

Storage API5 endpoints →GET/api/v1/storage/namespaces/{namespace}/recordsAlgaPSAList records in a namespace POST/api/v1/storage/namespaces/{namespace}/recordsAlgaPSABulk insert or update records GET/api/v1/storage/namespaces/{namespace}/records/{key}AlgaPSAGet a record by key PUT/api/v1/storage/namespaces/{namespace}/records/{key}AlgaPSACreate or update a record by key DELETE/api/v1/storage/namespaces/{namespace}/records/{key}AlgaPSADelete a record by key

Documents API4 endpoints →GET/api/documents/{documentId}/downloadAlgaPSADownload document attachment GET/api/documents/download/{fileId}AlgaPSADownload or export document file GET/api/documents/view/{fileId}AlgaPSAView document file inline GET/api/v1/documentsAlgaPSADocuments API namespace root

Files API1 endpoint →GET/api/files/{fileId}/downloadAlgaPSADownload file by ID

Email API9 endpoints →POST/api/email/oauth/initiateAlgaPSAAlgaDeskInitiate email OAuth flow POST/api/email/refresh-watchAlgaPSARefresh Gmail watch registration POST/api/email/webhooks/googleAlgaPSAReceive Google Gmail Pub/Sub webhook OPTIONS/api/email/webhooks/googleAlgaPSACORS preflight for Google email webhook GET/api/email/webhooks/microsoftAlgaPSAValidate Microsoft email webhook subscription POST/api/email/webhooks/microsoftAlgaPSAReceive Microsoft Graph email webhook OPTIONS/api/email/webhooks/microsoftAlgaPSACORS preflight for Microsoft email webhook POST/api/email/webhooks/testAlgaPSAPublish test inbound email event GET/api/v1/emailAlgaPSAAlgaDeskEmail API namespace root

Extensions API18 endpoints →GET/api/extensions/{extensionId}/agreementsAlgaPSAList agreements for extension GET/api/extensions/{extensionId}/agreements/{id}AlgaPSAGet agreement for extension GET/api/extensions/{extensionId}/statementsAlgaPSAList statements for extension GET/api/extensions/{extensionId}/statements/{id}AlgaPSAGet statement for extension GET/api/extensions/{extensionId}/statements/{id}/chargesAlgaPSAList charges for extension statement POST/api/extensions/{extensionId}/syncAlgaPSASync extension data GET/api/extensions/softwareone/agreementsAlgaPSAList SoftwareOne agreements POST/api/extensions/softwareone/agreementsAlgaPSASync SoftwareOne agreements GET/api/extensions/softwareone/agreements/{id}AlgaPSAGet SoftwareOne agreement GET/api/extensions/softwareone/statementsAlgaPSAList SoftwareOne statements POST/api/extensions/softwareone/statementsAlgaPSASync SoftwareOne statements GET/api/extensions/softwareone/statements/{id}AlgaPSAGet SoftwareOne statement GET/api/extensions/softwareone/statements/{id}/chargesAlgaPSAList SoftwareOne statement charges POST/api/extensions/softwareone/syncAlgaPSASync SoftwareOne data GET/api/installs/lookup-by-hostAlgaPSALookup extension install by runner host GET/api/installs/validateAlgaPSAValidate extension bundle content hash POST/api/v1/extensions/installAlgaPSAInstall an extension (EE)POST/api/v1/extensions/uninstallAlgaPSAUninstall an extension (EE)

Webhooks API23 endpoints →GET/api/v1/webhooksAlgaPSAList webhooks POST/api/v1/webhooksAlgaPSACreate webhook GET/api/v1/webhooks/{id}AlgaPSAGet webhook PUT/api/v1/webhooks/{id}AlgaPSAUpdate webhook DELETE/api/v1/webhooks/{id}AlgaPSADelete webhook GET/api/v1/webhooks/{id}/analyticsAlgaPSAGet webhook analytics GET/api/v1/webhooks/{id}/deliveriesAlgaPSAList webhook deliveries GET/api/v1/webhooks/{id}/deliveries/{delivery_id}AlgaPSAGet delivery detail POST/api/v1/webhooks/{id}/deliveries/{delivery_id}/retryAlgaPSARetry delivery GET/api/v1/webhooks/{id}/healthAlgaPSAGet webhook health POST/api/v1/webhooks/{id}/secret/rotateAlgaPSARotate webhook secret GET/api/v1/webhooks/{id}/subscriptionsAlgaPSAList webhook event subscriptions POST/api/v1/webhooks/{id}/testAlgaPSATest webhook by id GET/api/v1/webhooks/analyticsAlgaPSAGet system webhook analytics GET/api/v1/webhooks/eventsAlgaPSAList available webhook events GET/api/v1/webhooks/templatesAlgaPSAList webhook templates POST/api/v1/webhooks/templatesAlgaPSACreate webhook template GET/api/v1/webhooks/templates/{id}AlgaPSAGet webhook template detail (webhook getById wiring)PUT/api/v1/webhooks/templates/{id}AlgaPSAUpdate webhook template (webhook update wiring)DELETE/api/v1/webhooks/templates/{id}AlgaPSADelete webhook template (webhook delete wiring)POST/api/v1/webhooks/templates/{id}/createAlgaPSACreate webhook from template POST/api/v1/webhooks/testAlgaPSATest webhook configuration POST/api/v1/webhooks/verifyAlgaPSAVerify webhook signature

Inbound Webhooks API13 endpoints →GET/api/v1/inbound-webhooksAlgaPSAList inbound webhooks POST/api/v1/inbound-webhooksAlgaPSACreate inbound webhook GET/api/v1/inbound-webhooks/{id}AlgaPSAGet inbound webhook PUT/api/v1/inbound-webhooks/{id}AlgaPSAUpdate inbound webhook DELETE/api/v1/inbound-webhooks/{id}AlgaPSADelete inbound webhook POST/api/v1/inbound-webhooks/{id}/capture-sampleAlgaPSAEnable inbound webhook sample capture DELETE/api/v1/inbound-webhooks/{id}/capture-sampleAlgaPSAClear inbound webhook sample payload GET/api/v1/inbound-webhooks/{id}/deliveriesAlgaPSAList inbound webhook deliveries GET/api/v1/inbound-webhooks/{id}/deliveries/{deliveryId}AlgaPSAGet inbound webhook delivery POST/api/v1/inbound-webhooks/{id}/deliveries/{deliveryId}/replayAlgaPSAReplay inbound webhook delivery POST/api/v1/inbound-webhooks/{id}/rotate-secretAlgaPSARotate inbound webhook secret POST/api/v1/inbound-webhooks/{id}/testAlgaPSASend inbound webhook test request GET/api/v1/inbound-webhooks/actionsAlgaPSAList inbound webhook actions

Identity & access

Users API26 endpoints →GET/api/v1/usersAlgaPSAAlgaDeskList users POST/api/v1/usersAlgaPSAAlgaDeskCreate user GET/api/v1/users/{id}AlgaPSAAlgaDeskGet user PUT/api/v1/users/{id}AlgaPSAAlgaDeskUpdate user DELETE/api/v1/users/{id}AlgaPSAAlgaDeskDelete user DELETE/api/v1/users/{id}/2fa/disableAlgaPSAAlgaDeskDisable user 2FA POST/api/v1/users/{id}/2fa/enableAlgaPSAAlgaDeskEnable user 2FA GET/api/v1/users/{id}/activityAlgaPSAAlgaDeskGet user activity POST/api/v1/users/{id}/avatarAlgaPSAAlgaDeskUpload user avatar DELETE/api/v1/users/{id}/avatarAlgaPSAAlgaDeskDelete user avatar PUT/api/v1/users/{id}/passwordAlgaPSAAlgaDeskChange user password GET/api/v1/users/{id}/permissionsAlgaPSAAlgaDeskGet user effective permissions GET/api/v1/users/{id}/preferencesAlgaPSAAlgaDeskGet user preferences PUT/api/v1/users/{id}/preferencesAlgaPSAAlgaDeskUpdate user preferences GET/api/v1/users/{id}/rolesAlgaPSAAlgaDeskList user roles POST/api/v1/users/{id}/rolesAlgaPSAAlgaDeskAssign user roles PUT/api/v1/users/{id}/rolesAlgaPSAAlgaDeskReplace user roles DELETE/api/v1/users/{id}/rolesAlgaPSAAlgaDeskRemove user roles GET/api/v1/users/{id}/teamsAlgaPSAAlgaDeskList user teams POST/api/v1/users/{id}/teamsAlgaPSAAlgaDeskAdd user to team (route currently mapped to user create)DELETE/api/v1/users/{id}/teams/{teamId}AlgaPSAAlgaDeskRemove user from team (route currently mapped to user delete)GET/api/v1/users/activityAlgaPSAAlgaDeskList global user activity POST/api/v1/users/bulk/createAlgaPSAAlgaDeskBulk create users (route currently mapped to single create)PUT/api/v1/users/bulk/deactivateAlgaPSAAlgaDeskBulk deactivate users (route currently mapped to update-by-id)GET/api/v1/users/searchAlgaPSAAlgaDeskSearch users GET/api/v1/users/statsAlgaPSAAlgaDeskGet user stats

User API2 endpoints →GET/api/v1/user/telemetry-decisionAlgaPSAGet telemetry decision GET/api/v1/user/telemetry-preferencesAlgaPSAGet telemetry preferences

Roles API10 endpoints →GET/api/v1/rolesAlgaPSAList roles POST/api/v1/rolesAlgaPSACreate role GET/api/v1/roles/{id}AlgaPSAGet role PUT/api/v1/roles/{id}AlgaPSAUpdate role DELETE/api/v1/roles/{id}AlgaPSADelete role POST/api/v1/roles/{id}/cloneAlgaPSAClone role GET/api/v1/roles/{id}/permissionsAlgaPSAGet role permissions PUT/api/v1/roles/{id}/permissionsAlgaPSAReplace role permissions POST/api/v1/roles/bulkAlgaPSABulk create roles GET/api/v1/roles/templatesAlgaPSAList role templates

User Roles API1 endpoint →GET/api/v1/user-rolesAlgaPSAList users with roles

Permissions API7 endpoints →GET/api/v1/permissionsAlgaPSAList permissions POST/api/v1/permissionsAlgaPSACreate permission GET/api/v1/permissions/{id}AlgaPSAGet permission PUT/api/v1/permissions/{id}AlgaPSAUpdate permission DELETE/api/v1/permissions/{id}AlgaPSADelete permission GET/api/v1/permissions/{id}/rolesAlgaPSAList roles using permission GET/api/v1/permissions/categoriesAlgaPSAList permission categories

RBAC API2 endpoints →GET/api/v1/rbac/analyticsAlgaPSAGet RBAC analytics GET/api/v1/rbac/auditAlgaPSAGet RBAC audit log

Teams API22 endpoints →GET/api/v1/teamsAlgaPSAAlgaDeskList teams POST/api/v1/teamsAlgaPSAAlgaDeskCreate team GET/api/v1/teams/{id}AlgaPSAAlgaDeskGet team PUT/api/v1/teams/{id}AlgaPSAAlgaDeskUpdate team DELETE/api/v1/teams/{id}AlgaPSAAlgaDeskDelete team GET/api/v1/teams/{id}/analyticsAlgaPSAAlgaDeskGet team analytics POST/api/v1/teams/{id}/hierarchyAlgaPSAAlgaDeskAttach team to parent hierarchy DELETE/api/v1/teams/{id}/hierarchyAlgaPSAAlgaDeskDetach team from hierarchy PUT/api/v1/teams/{id}/managerAlgaPSAAlgaDeskAssign team manager GET/api/v1/teams/{id}/membersAlgaPSAAlgaDeskList team members POST/api/v1/teams/{id}/membersAlgaPSAAlgaDeskAdd team member DELETE/api/v1/teams/{id}/members/{userId}AlgaPSAAlgaDeskRemove team member POST/api/v1/teams/{id}/members/bulkAlgaPSAAlgaDeskBulk add team members GET/api/v1/teams/{id}/permissionsAlgaPSAAlgaDeskList team permissions POST/api/v1/teams/{id}/permissionsAlgaPSAAlgaDeskGrant team permission DELETE/api/v1/teams/{id}/permissions/{permissionId}AlgaPSAAlgaDeskRevoke team permission GET/api/v1/teams/{id}/projectsAlgaPSAAlgaDeskList team projects PUT/api/v1/teams/bulkAlgaPSAAlgaDeskBulk update teams DELETE/api/v1/teams/bulkAlgaPSAAlgaDeskBulk delete teams GET/api/v1/teams/hierarchyAlgaPSAAlgaDeskGet team hierarchy GET/api/v1/teams/searchAlgaPSAAlgaDeskSearch teams GET/api/v1/teams/statsAlgaPSAAlgaDeskGet team stats

Permission Checks API1 endpoint →POST/api/v1/permission-checksAlgaPSACheck user permissions

Feature Access API1 endpoint →POST/api/v1/feature-accessAlgaPSACheck feature access

AI & utilities

AI API1 endpoint →POST/api/v1/ai/document-assistAlgaPSAAI document assistance (streaming, EE)

Search API1 endpoint →GET/api/v1/searchAlgaPSAUnified full-text search

Meta API9 endpoints →GET/api/v1/meta/docsAlgaPSAAlgaDeskGet API docs GET/api/v1/meta/endpointsAlgaPSAAlgaDeskList API endpoints metadata GET/api/v1/meta/healthAlgaPSAAlgaDeskGet API health metadata GET/api/v1/meta/mcp-registryAlgaPSAAlgaDeskGET v1 GET/api/v1/meta/openapiAlgaPSAAlgaDeskGet generated OpenAPI metadata GET/api/v1/meta/permissionsAlgaPSAAlgaDeskList API permissions metadata GET/api/v1/meta/schemasAlgaPSAAlgaDeskList API schemas metadata GET/api/v1/meta/sdkAlgaPSAAlgaDeskGenerate SDK metadata payload GET/api/v1/meta/statsAlgaPSAAlgaDeskGet API stats metadata

MCP API20 endpoints →GET/api/mcpAlgaPSAGET mcp POST/api/mcpAlgaPSAPOST mcp GET/api/mcp/oauth/authorizeAlgaPSAGET mcp POST/api/mcp/oauth/authorizeAlgaPSAPOST mcp POST/api/mcp/oauth/revokeAlgaPSAPOST mcp POST/api/mcp/oauth/tokenAlgaPSAPOST mcp GET/api/v1/mcp/agentsAlgaPSAGET v1 POST/api/v1/mcp/agentsAlgaPSAPOST v1 PATCH/api/v1/mcp/agentsAlgaPSAPATCH v1 DELETE/api/v1/mcp/agentsAlgaPSADELETE v1 GET/api/v1/mcp/auditAlgaPSAGET v1 GET/api/v1/mcp/connect/callbackAlgaPSAGET v1 POST/api/v1/mcp/connect/startAlgaPSAPOST v1 GET/api/v1/mcp/connectionsAlgaPSAGET v1 DELETE/api/v1/mcp/connectionsAlgaPSADELETE v1 GET/api/v1/mcp/idp-providersAlgaPSAGET v1 POST/api/v1/mcp/idp-providersAlgaPSAPOST v1 GET/api/v1/mcp/idp-suggestionsAlgaPSAGET v1 GET/api/v1/mcp/platform-providersAlgaPSAGET v1 GET/api/v1/mcp/rolesAlgaPSAGET v1