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.

bash

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.md

Request an endpoint

Don't see what you need? Tell us what you'd like to build with.

Have an endpoint in mind?

Share the resource, method, and use case — we prioritize requests from real workflows.

Agents

Hire, configure and fire the AI agents that work a desk.

/api/public/v1/agents

/api/public/v1/agents/{agentId}

/api/public/v1/agents

Update an agent

/api/public/v1/agents/{agentId}

/api/public/v1/agents/{agentId}

Analytics

The company performance report and the metric vocabulary behind it.

List analytics metrics

/api/public/v1/analytics/metrics

Get the analytics report

/api/public/v1/analytics/report

Appointments

Read appointments, manage services and availability.

List appointments

/api/public/v1/appointments

Get an appointment

/api/public/v1/appointments/{appointmentId}

Update appointment status

/api/public/v1/appointments/{appointmentId}/update-status

List appointment services

/api/public/v1/appointment-services

Create appointment service

/api/public/v1/appointment-services

Update appointment service

/api/public/v1/appointment-services/{serviceId}

Delete appointment service

/api/public/v1/appointment-services/{serviceId}

List availability windows

/api/public/v1/appointment-availability

Create availability window

/api/public/v1/appointment-availability

Delete availability window

/api/public/v1/appointment-availability/{availabilityId}

Billing

Payment methods.

List payment methods

/api/public/v1/billing/payment-methods

Set default payment method

/api/public/v1/billing/payment-methods/set-default

Calendar

Schedule events, invite people, and answer invitations. Writes here send mail.

List calendar events

/api/public/v1/calendar-events

Get a calendar event

/api/public/v1/calendar-events/{eventId}

Create a calendar event

/api/public/v1/calendar-events

Update a calendar event

/api/public/v1/calendar-events/{eventId}

Delete a calendar event

/api/public/v1/calendar-events/{eventId}

Answer a calendar invitation

/api/public/v1/calendar-events/{eventId}/rsvp

Company structure

Company chart

Reporting lines: who works where and who they report to.

Get the company chart

/api/public/v1/company-chart

Departments

Companyal departments used by employees.

List departments

/api/public/v1/departments

Create a department

/api/public/v1/departments

Update a department

/api/public/v1/departments/{departmentId}

Delete a department

/api/public/v1/departments/{departmentId}

Job Titles

Job titles inside departments used by employees.

List job titles

/api/public/v1/job-titles

Create a job title

/api/public/v1/job-titles

Update a job title

/api/public/v1/job-titles/{jobTitleId}

Delete a job title

/api/public/v1/job-titles/{jobTitleId}

Customer

Call scripts

The branching scripts reps follow on a call.

List call scripts

/api/public/v1/call-scripts

Get a call script

/api/public/v1/call-scripts/{scriptId}

Create a call script

/api/public/v1/call-scripts

Update a call script

/api/public/v1/call-scripts/{scriptId}

Delete a call script

/api/public/v1/call-scripts/{scriptId}

Campaigns

One message written once and sent to an audience of customers.

/api/public/v1/campaigns

/api/public/v1/campaigns/{campaignId}

Create a campaign

/api/public/v1/campaigns

Update a campaign

/api/public/v1/campaigns/{campaignId}

Send, pause or cancel a campaign

/api/public/v1/campaigns/{campaignId}/send

Delete a campaign

/api/public/v1/campaigns/{campaignId}

Custom Fields

Define per-location custom fields on customers and read/write their values.

List customer custom fields

/api/public/v1/customer-custom-fields

Create a customer custom field

/api/public/v1/customer-custom-fields

Update a customer custom field

/api/public/v1/customer-custom-fields/{customFieldId}

Delete a customer custom field

/api/public/v1/customer-custom-fields/{customFieldId}

Get customer custom field values

/api/public/v1/customers/{accountId}/custom-fields

Set customer custom field values

/api/public/v1/customers/{accountId}/custom-fields

Customers (xRM)

Manage customers in a location.

/api/public/v1/customers

/api/public/v1/customers/{accountId}

Create a customer

/api/public/v1/customers

Update a customer

/api/public/v1/customers/{accountId}

Leads

Prospects staged before they become customers, and converting one.

/api/public/v1/leads

/api/public/v1/leads/{leadId}

/api/public/v1/leads

/api/public/v1/leads/{leadId}

Convert a lead to a customer

/api/public/v1/leads/{leadId}/convert

/api/public/v1/leads/{leadId}

Pipeline

Deals on the board, the stages they move through, and winning or losing one.

Get a location’s pipeline

/api/public/v1/pipelines

/api/public/v1/deals

/api/public/v1/deals/{dealId}

/api/public/v1/deals

/api/public/v1/deals/{dealId}

Move a deal to another stage

/api/public/v1/deals/{dealId}/move

Win, lose or re-open a deal

/api/public/v1/deals/{dealId}/close

/api/public/v1/deals/{dealId}

Domains

Manage custom domains.

/api/public/v1/domains

/api/public/v1/domains/{domainId}

/api/public/v1/domains

Email Addresses

Manage email addresses on custom domains.

List email addresses

/api/public/v1/email-addresses

Create an email address

/api/public/v1/email-addresses

Delete an email address

/api/public/v1/email-addresses/{emailAddressId}

Employee

Directory

The people who work at your company.

Deactivate an employee

/api/public/v1/employees/{employeeId}/deactivate

/api/public/v1/employees

Invitations

Invite people to join your company.

List employee invitations

/api/public/v1/employee-invitations

Invite an employee

/api/public/v1/employee-invitations

Revoke an invitation

/api/public/v1/employee-invitations/{invitationId}

Onboardings

Track and advance employee onboarding.

List employees in onboarding

/api/public/v1/employee-onboardings

Get an onboarding employee

/api/public/v1/employee-onboardings/{employeeId}

Permissions

Read and reconcile one employee's scope grants.

Get an employee’s permissions

/api/public/v1/employees/{employeeId}/permissions

Set an employee’s permissions

/api/public/v1/employees/{employeeId}/permissions

Finances

Invoices

Raise invoices, email their pay links, void and delete them.

/api/public/v1/invoices

/api/public/v1/invoices/{invoiceId}

Create an invoice

/api/public/v1/invoices

Email an invoice

/api/public/v1/invoices/{invoiceId}/send-email

Void an invoice

/api/public/v1/invoices/{invoiceId}/void

Delete an invoice

/api/public/v1/invoices/{invoiceId}

Ledger

Read the ledger, record entries, and settle what is outstanding.

Record a transaction

/api/public/v1/transactions

Update a transaction

/api/public/v1/transactions/{transactionId}

Mark a transaction paid

/api/public/v1/transactions/{transactionId}/mark-paid

Void a transaction

/api/public/v1/transactions/{transactionId}

List transactions

/api/public/v1/transactions

Get a transaction

/api/public/v1/transactions/{transactionId}

Payables

What the company owes and by when.

/api/public/v1/payables

Payouts

Money moved out to a connected bank account.

/api/public/v1/payouts

Create a payout

/api/public/v1/payouts

Taxes

Estimated liability, and the filings prepared against it.

Get tax liability

/api/public/v1/tax-liability

List tax filings

/api/public/v1/tax-filings

Get a tax filing

/api/public/v1/tax-filings/{filingId}

Update a tax filing

/api/public/v1/tax-filings/{filingId}

HR

Benefits

The benefits catalog, and who is enrolled in what.

/api/public/v1/benefits

/api/public/v1/benefits/{benefitId}

Create a benefit

/api/public/v1/benefits

Update a benefit

/api/public/v1/benefits/{benefitId}

Delete a benefit

/api/public/v1/benefits/{benefitId}

List an employee’s benefits

/api/public/v1/employees/{employeeId}/benefits

Set an employee’s benefits

/api/public/v1/employees/{employeeId}/benefits

Performance

Write and read performance reviews, kept as history.

List performance reviews

/api/public/v1/performance-reviews

Get a performance review

/api/public/v1/performance-reviews/{reviewId}

Write a performance review

/api/public/v1/performance-reviews

Shifts

The planned schedule for a location's staff.

/api/public/v1/shifts

/api/public/v1/shifts/{shiftId}

/api/public/v1/shifts

/api/public/v1/shifts/{shiftId}

/api/public/v1/shifts/{shiftId}

Time clock

Hours actually worked — clocking in, clocking out, and reading timesheets.

List time clock entries

/api/public/v1/time-clock-entries

/api/public/v1/time-clock-entries

/api/public/v1/time-clock-entries/{entryId}/clock-out

Time off

Request time off, approve or deny it, and withdraw a request.

List time-off requests

/api/public/v1/time-off-requests

Get a time-off request

/api/public/v1/time-off-requests/{requestId}

Request time off

/api/public/v1/time-off-requests

Approve or deny time off

/api/public/v1/time-off-requests/{requestId}/review

Withdraw a time-off request

/api/public/v1/time-off-requests/{requestId}/cancel

Legal Entities

Manage legal entities for your company.

List legal entities

/api/public/v1/legal-entities

Get a legal entity

/api/public/v1/legal-entities/{legalEntityId}

Create a legal entity

/api/public/v1/legal-entities

File an amendment

/api/public/v1/legal-entities/{legalEntityId}/amendments

Locations

Create, update, archive, and list locations.

/api/public/v1/locations

/api/public/v1/locations/{locationId}

Create a location

/api/public/v1/locations

Update a location

/api/public/v1/locations/{locationId}

Archive a location

/api/public/v1/locations/{locationId}/archive

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/emails

Update an email

/api/public/v1/emails/{emailId}

List email folders

/api/public/v1/email-folders

Create an email folder

/api/public/v1/email-folders

Meetings

Video rooms, who is invited, shared notes, and recordings.

List meeting rooms

/api/public/v1/meeting-rooms

Get a meeting room

/api/public/v1/meeting-rooms/{roomId}

Create a meeting room

/api/public/v1/meeting-rooms

Update a meeting room

/api/public/v1/meeting-rooms/{roomId}

Delete a meeting room

/api/public/v1/meeting-rooms/{roomId}

List meeting recordings

/api/public/v1/meeting-recordings

Notifications

List notifications and mark them handled.

Get notification preferences

/api/public/v1/notification-preferences

Update notification preferences

/api/public/v1/notification-preferences

List notifications

/api/public/v1/notifications

Mark notification as handled

/api/public/v1/notifications/{notificationId}/handle

Orders

Read orders placed against products.

/api/public/v1/orders

/api/public/v1/orders/{orderId}

Products

Manage inventory products in a location.

/api/public/v1/products

/api/public/v1/products/{productId}

Create a product

/api/public/v1/products

Update a product

/api/public/v1/products/{productId}

Delete a product

/api/public/v1/products/{productId}

Projects

Labels

Each project’s own tag vocabulary, for labeling its tickets.

List project labels

/api/public/v1/project-labels

Create a project label

/api/public/v1/project-labels

Delete a project label

/api/public/v1/project-labels/{labelId}

Milestones

Themed groupings of tickets inside one project — the level the roadmap plots.

List milestones

/api/public/v1/milestones

Get a milestone

/api/public/v1/milestones/{milestoneId}

Create a milestone

/api/public/v1/milestones

Update a milestone

/api/public/v1/milestones/{milestoneId}

Delete a milestone

/api/public/v1/milestones/{milestoneId}

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.

/api/public/v1/projects

/api/public/v1/projects/{projectId}

Create a project

/api/public/v1/projects

Update a project

/api/public/v1/projects/{projectId}

Delete a project

/api/public/v1/projects/{projectId}

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}

Create a ticket

/api/public/v1/tickets

Update a ticket

/api/public/v1/tickets/{ticketId}

Delete a ticket

/api/public/v1/tickets/{ticketId}

List comments on a ticket

/api/public/v1/tickets/{ticketId}/comments

Comment on a ticket

/api/public/v1/tickets/{ticketId}/comments

Quality

Plant QA: line checks, the specs they are judged against, shift sessions and corrective actions.

List QA line checks

/api/public/v1/qa-checks

Record a QA line check

/api/public/v1/qa-checks

List QA product specs

/api/public/v1/qa-specs

Create or update a QA product spec

/api/public/v1/qa-specs

List QA shift sessions

/api/public/v1/qa-shift-sessions

List QA corrective actions

/api/public/v1/qa-corrective-actions

Open or update a corrective action

/api/public/v1/qa-corrective-actions

Security

Audit logs and IP whitelist management.

List audit logs

/api/public/v1/security/audit-logs

List IP whitelist

/api/public/v1/security/ip-whitelist

Add IP to whitelist

/api/public/v1/security/ip-whitelist

Remove IP from whitelist

/api/public/v1/security/ip-whitelist/{id}

Settings

Personal and company-level settings.

Get company settings

/api/public/v1/settings/company

Update company settings

/api/public/v1/settings/company

SSO

The company Single Sign-On configuration.

Get the SSO configuration

/api/public/v1/sso

Storefront

Blog

Posts on a location's public blog.

List blog posts

/api/public/v1/blog-posts

Get a blog post

/api/public/v1/blog-posts/{postId}

Create a blog post

/api/public/v1/blog-posts

Update a blog post

/api/public/v1/blog-posts/{postId}

Delete a blog post

/api/public/v1/blog-posts/{postId}

Gallery

Manage gallery photos (delete only — uploads happen in the dashboard).

List gallery photos

/api/public/v1/gallery

Delete a gallery photo

/api/public/v1/gallery/{photoId}

Location Hours

Read/update per-day location hours.

Get location hours

/api/public/v1/location-hours

Update location hours

/api/public/v1/location-hours

Manage newsletter subscribers.

List newsletter subscriptions

/api/public/v1/newsletter-subscriptions

Remove a newsletter subscription

/api/public/v1/newsletter-subscriptions/{subscriptionId}

Threads

Internal team chat. Membership is the access rule — a token sees its own employee's conversations.

List conversations

/api/public/v1/conversations

List messages in a conversation

/api/public/v1/conversations/{conversationId}/messages

/api/public/v1/conversations/{conversationId}/messages

Usage

What the company is consuming this cycle and what it costs.

Get the usage report

/api/public/v1/usage

Vault

Files, folders, documents and stored credentials. Access is checked per item, and reads are audited.

List Vault documents

/api/public/v1/vault-documents

Get a Vault document

/api/public/v1/vault-documents/{documentId}

Create a Vault document or folder

/api/public/v1/vault-documents

Update a Vault document

/api/public/v1/vault-documents/{documentId}

Archive or delete a Vault document

/api/public/v1/vault-documents/{documentId}

Get a download URL

/api/public/v1/vault-documents/{documentId}/download

List Vault folders

/api/public/v1/vault-folders

List Vault credentials

/api/public/v1/vault-credentials

Reveal a Vault credential

/api/public/v1/vault-credentials/{credentialId}