API / Endpoints
Endpoints
Browse every available endpoint in the Pixelbase API.
For agents
The whole reference — every endpoint with its scopes, its console location, its parameters and an example response — in one fetch, rather than crawling these pages. The per-endpoint document is the targeted read when you already know which endpoint the question is about.
curl https://www.pxb.app/docs/api/docs.md
curl https://www.pxb.app/docs/api/docs.json
curl https://www.pxb.app/docs/api/endpoints/list-customers/docs.mdRequest an endpoint
Don't see what you need? Tell us what you'd like to build with.
Share the resource, method, and use case — we prioritize requests from real workflows.
Analytics
The company performance report and the metric vocabulary behind it.
Appointments
Read appointments, manage services and availability.
/api/public/v1/appointments/api/public/v1/appointments/{appointmentId}/api/public/v1/appointments/{appointmentId}/update-status/api/public/v1/appointment-services/api/public/v1/appointment-services/api/public/v1/appointment-services/{serviceId}/api/public/v1/appointment-services/{serviceId}/api/public/v1/appointment-availability/api/public/v1/appointment-availability/api/public/v1/appointment-availability/{availabilityId}Billing
Payment methods.
Boosts
Turn on and off the AI automation a company pays for monthly, one area at a time. Pixelbase staff only, for now.
Builder
Deployments
The Vercel deployment stream across the platform and portals projects.
Sessions
The agent working the Pixelbase repository: its sessions, their status, pull requests and preview builds. Pixelbase staff only.
/api/public/v1/build-sessions/api/public/v1/build-sessions/api/public/v1/build-sessions/{sessionId}/api/public/v1/build-sessions/{sessionId}/api/public/v1/build-sessions/{sessionId}/messages/api/public/v1/build-sessions/{sessionId}/messages/api/public/v1/build-sessions/{sessionId}/interrupt/api/public/v1/build-sessions/{sessionId}/retry-start/api/public/v1/build-sessions/{sessionId}/archive/api/public/v1/build-sessions/{sessionId}/reopen/api/public/v1/build-sessions/{sessionId}/approve-planCalendar
Schedule events, invite people, and answer invitations. Writes here send mail.
/api/public/v1/calendar-events/api/public/v1/calendar-events/{eventId}/api/public/v1/calendar-events/api/public/v1/calendar-events/{eventId}/api/public/v1/calendar-events/{eventId}/api/public/v1/calendar-events/{eventId}/rsvpCompany structure
Company chart
Reporting lines: who works where and who they report to.
Departments
Companyal departments used by employees.
Job Titles
Job titles inside departments used by employees.
Contact Pixelbase
Send the Pixelbase team a request — what an assistant does when Pixelbase can’t do what you asked.
Customer
Call scripts
The branching scripts reps follow on a call.
/api/public/v1/call-scripts/api/public/v1/call-scripts/{scriptId}/api/public/v1/call-scripts/api/public/v1/call-scripts/{scriptId}/api/public/v1/call-scripts/{scriptId}/api/public/v1/call-scripts/{scriptId}/nodes/api/public/v1/call-scripts/{scriptId}/nodes/{nodeId}/api/public/v1/call-scripts/{scriptId}/nodes/{nodeId}/move/api/public/v1/call-scripts/{scriptId}/nodes/{nodeId}/api/public/v1/call-scripts/{scriptId}/tree/api/public/v1/call-scripts/{scriptId}/runsCampaigns
One message written once and sent to an audience of customers.
/api/public/v1/campaigns/api/public/v1/campaigns/{campaignId}/api/public/v1/campaigns/api/public/v1/campaigns/{campaignId}/api/public/v1/campaigns/{campaignId}/send/api/public/v1/campaigns/{campaignId}Custom Fields
Define per-location custom fields on customers and read/write their values.
/api/public/v1/customer-custom-fields/api/public/v1/customer-custom-fields/api/public/v1/customer-custom-fields/{customFieldId}/api/public/v1/customer-custom-fields/{customFieldId}/api/public/v1/customers/{accountId}/custom-fields/api/public/v1/customers/{accountId}/custom-fieldsCustomers (xRM)
Manage customers in a location.
Leads
Prospects staged before they become customers, and converting one.
Pipeline
Deals on the board, the stages they move through, and winning or losing one.
/api/public/v1/pipelines/api/public/v1/deals/api/public/v1/deals/{dealId}/api/public/v1/deals/api/public/v1/deals/{dealId}/api/public/v1/deals/{dealId}/move/api/public/v1/deals/{dealId}/close/api/public/v1/deals/{dealId}Domains
Manage custom domains.
Email Addresses
Manage email addresses on custom domains.
Employee
Directory
The people who work at your company.
Invitations
Invite people to join your company.
Onboardings
Track and advance employee onboarding.
Permissions
Read and reconcile one employee's scope grants.
Finances
Invoices
Raise invoices, email their pay links, and void them.
/api/public/v1/invoices/api/public/v1/invoices/{invoiceId}/api/public/v1/invoices/api/public/v1/invoices/{invoiceId}/send-email/api/public/v1/invoices/{invoiceId}/send-text/api/public/v1/invoices/{invoiceId}/voidLedger
Read the ledger, record entries, and settle what is outstanding.
/api/public/v1/transactions/api/public/v1/transactions/{transactionId}/api/public/v1/transactions/{transactionId}/mark-paid/api/public/v1/transactions/{transactionId}/api/public/v1/transactions/api/public/v1/transactions/{transactionId}Payouts
Money moved out to a connected bank account.
Taxes
Estimated liability, and the filings prepared against it.
HR
Benefits
The benefits catalog, and who is enrolled in what.
/api/public/v1/benefits/api/public/v1/benefits/{benefitId}/api/public/v1/benefits/api/public/v1/benefits/{benefitId}/api/public/v1/benefits/{benefitId}/api/public/v1/employees/{employeeId}/benefits/api/public/v1/employees/{employeeId}/benefitsPerformance
Write and read performance reviews, kept as history.
Shifts
The planned schedule for a location's staff.
Time clock
Hours actually worked — clocking in, clocking out, and reading timesheets.
Time off
Request time off, approve or deny it, and withdraw a request.
/api/public/v1/time-off-requests/api/public/v1/time-off-requests/{requestId}/api/public/v1/time-off-requests/api/public/v1/time-off-requests/{requestId}/review/api/public/v1/time-off-requests/{requestId}/cancelLegal Entities
Manage legal entities for your company.
Locations
Create, update, archive, and list locations.
Mailbox
Read and send mail from the token employee's own addresses, and file it into folders.
/api/public/v1/emails/api/public/v1/emails/{emailId}/api/public/v1/email-threads/{threadId}/api/public/v1/emails/api/public/v1/emails/{emailId}/api/public/v1/email-drafts/api/public/v1/email-drafts/api/public/v1/email-drafts/{draftId}/api/public/v1/email-drafts/{draftId}/api/public/v1/email-drafts/{draftId}/api/public/v1/email-drafts/{draftId}/send/api/public/v1/email-folders/api/public/v1/email-foldersMeetings
Video rooms, who is invited, shared notes, and recordings.
/api/public/v1/meeting-rooms/api/public/v1/meeting-rooms/{roomId}/api/public/v1/meeting-rooms/api/public/v1/meeting-rooms/{roomId}/api/public/v1/meeting-rooms/{roomId}/api/public/v1/meeting-recordingsNotifications
List notifications and mark them handled.
Orders
Read orders placed against products.
Products
Manage inventory products in a location.
Projects
Labels
Each project’s own tag vocabulary, for labeling its tickets.
Milestones
Themed groupings of tickets inside one project — the level the roadmap plots.
Projects
The containers work is filed in. A project holds its own tickets, milestones and goals, and its key prefixes every ticket id in it.
Tickets
The work itself: create it, move it, comment on it, and restore what was archived.
/api/public/v1/tickets/api/public/v1/tickets/{ticketId}/api/public/v1/tickets/api/public/v1/tickets/{ticketId}/api/public/v1/tickets/{ticketId}/api/public/v1/tickets/{ticketId}/comments/api/public/v1/tickets/{ticketId}/commentsQuality
Plant QA: line checks, the specs they are judged against, shift sessions and corrective actions.
/api/public/v1/qa-checks/api/public/v1/qa-checks/api/public/v1/qa-specs/api/public/v1/qa-specs/api/public/v1/qa-shift-sessions/api/public/v1/qa-corrective-actions/api/public/v1/qa-corrective-actionsSecurity
Audit logs and IP whitelist management.
Settings
Personal and company-level settings.
SSO
The company Single Sign-On configuration.
Storefront
Blog
Posts on a location's public blog.
Gallery
Manage gallery photos (delete only — uploads happen in the dashboard).
Location Hours
Read/update per-day location hours.
Support
Every customer’s Support channel, for Pixelbase support staff: whose turn it is, and the conversation.
Threads
Internal team chat. Membership is the access rule — a token sees its own employee's conversations.
/api/public/v1/conversations/api/public/v1/conversations/{conversationId}/api/public/v1/conversations/api/public/v1/conversations/{conversationId}/messages/api/public/v1/conversations/{conversationId}/messages/api/public/v1/conversations/{conversationId}/messages/{messageId}/replies/api/public/v1/threads/unread/api/public/v1/conversations/{conversationId}/read/api/public/v1/conversations/{conversationId}/read/api/public/v1/conversations/{conversationId}/messages/{messageId}/readUsage
What the company is consuming this cycle and what it costs.
Vault
Files, folders, documents and stored credentials. Access is checked per item, and reads are audited.
/api/public/v1/vault-documents/api/public/v1/vault-documents/{documentId}/api/public/v1/vault-documents/api/public/v1/vault-documents/{documentId}/api/public/v1/vault-documents/{documentId}/api/public/v1/vault-documents/{documentId}/download/api/public/v1/vault-folders/api/public/v1/vault-credentials/api/public/v1/vault-credentials/{credentialId}Webhooks
Push data to Pixelbase from your other systems.