API / Endpoints

Endpoints

Browse every available endpoint in the Pixelbase API.

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.

Account

Information about the user the API key acts as.

GET
Get current user
/api/public/v1/me
→
PATCH
Update current user
/api/public/v1/me
→

Appointments

Read appointments, manage services and availability.

GET
List appointments
/api/public/v1/appointments
→
GET
Get an appointment
/api/public/v1/appointments/{appointmentId}
→
POST
Update appointment status
/api/public/v1/appointments/{appointmentId}/update-status
→
GET
List appointment services
/api/public/v1/appointment-services
→
POST
Create appointment service
/api/public/v1/appointment-services
→
PATCH
Update appointment service
/api/public/v1/appointment-services/{serviceId}
→
DELETE
Delete appointment service
/api/public/v1/appointment-services/{serviceId}
→
GET
List availability windows
/api/public/v1/appointment-availability
→
POST
Create availability window
/api/public/v1/appointment-availability
→
DELETE
Delete availability window
/api/public/v1/appointment-availability/{availabilityId}
→

Billing

Payment methods and auto-refill settings.

GET
List payment methods
/api/public/v1/billing/payment-methods
→
POST
Set default payment method
/api/public/v1/billing/payment-methods/set-default
→
GET
Get auto-refill settings
/api/public/v1/billing/auto-refill
→
PATCH
Update auto-refill settings
/api/public/v1/billing/auto-refill
→

Businesses

Create, update, archive, and list businesses.

GET
List businesses
/api/public/v1/businesses
→
GET
Get a business
/api/public/v1/businesses/{businessId}
→
POST
Create a business
/api/public/v1/businesses
→
PATCH
Update a business
/api/public/v1/businesses/{businessId}
→
POST
Archive a business
/api/public/v1/businesses/{businessId}/archive
→

Customer

Domains

Manage custom domains.

GET
List domains
/api/public/v1/domains
→
GET
Get a domain
/api/public/v1/domains/{domainId}
→
POST
Buy a domain
/api/public/v1/domains
→

Email Addresses

Manage email addresses on custom domains.

GET
List email addresses
/api/public/v1/email-addresses
→
POST
Create an email address
/api/public/v1/email-addresses
→
DELETE
Delete an email address
/api/public/v1/email-addresses/{emailAddressId}
→

Employee

Financial

Read organization-level transactions.

GET
List transactions
/api/public/v1/transactions
→
GET
Get a transaction
/api/public/v1/transactions/{transactionId}
→

Legal Entities

Manage legal entities for your organization.

GET
List legal entities
/api/public/v1/legal-entities
→
GET
Get a legal entity
/api/public/v1/legal-entities/{legalEntityId}
→
POST
Create a legal entity
/api/public/v1/legal-entities
→
POST
File an amendment
/api/public/v1/legal-entities/{legalEntityId}/amendments
→

Notifications

List notifications and mark them handled.

GET
List notifications
/api/public/v1/notifications
→
POST
Mark notification as handled
/api/public/v1/notifications/{notificationId}/handle
→

Orders

Read orders placed against products.

GET
List orders
/api/public/v1/orders
→
GET
Get an order
/api/public/v1/orders/{orderId}
→

Org structure

Products

Manage inventory products in a business.

GET
List products
/api/public/v1/products
→
GET
Get a product
/api/public/v1/products/{productId}
→
POST
Create a product
/api/public/v1/products
→
PATCH
Update a product
/api/public/v1/products/{productId}
→
DELETE
Delete a product
/api/public/v1/products/{productId}
→

Projects

Manage projects and sprints.

GET
List projects
/api/public/v1/projects
→
GET
Get a project
/api/public/v1/projects/{projectId}
→
POST
Create a project
/api/public/v1/projects
→
PATCH
Update a project
/api/public/v1/projects/{projectId}
→
GET
List sprints
/api/public/v1/sprints
→
POST
Create a sprint
/api/public/v1/sprints
→
PATCH
Update a sprint
/api/public/v1/sprints/{sprintId}
→
DELETE
Delete a sprint
/api/public/v1/sprints/{sprintId}
→

Security

Audit logs and IP whitelist management.

GET
List audit logs
/api/public/v1/security/audit-logs
→
GET
List IP whitelist
/api/public/v1/security/ip-whitelist
→
POST
Add IP to whitelist
/api/public/v1/security/ip-whitelist
→
DELETE
Remove IP from whitelist
/api/public/v1/security/ip-whitelist/{id}
→

Settings

Personal and organization-level settings.

GET
Get personal settings
/api/public/v1/settings/personal
→
PATCH
Update personal settings
/api/public/v1/settings/personal
→
GET
Get organization settings
/api/public/v1/settings/organization
→
PATCH
Update organization settings
/api/public/v1/settings/organization
→

Storefront

Gallery

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

GET
List gallery photos
/api/public/v1/gallery
→
DELETE
Delete a gallery photo
/api/public/v1/gallery/{photoId}
→

Support Cases

Open, message, and close support cases.

GET
List support cases
/api/public/v1/support-cases
→
GET
Get a support case
/api/public/v1/support-cases/{caseId}
→
POST
Open a support case
/api/public/v1/support-cases
→
POST
Add a message to a case
/api/public/v1/support-cases/{caseId}/messages
→
POST
Close a support case
/api/public/v1/support-cases/{caseId}/close
→

Tickets

Manage project tickets and add comments.

GET
List tickets
/api/public/v1/tickets
→
GET
Get a ticket
/api/public/v1/tickets/{ticketId}
→
POST
Create a ticket
/api/public/v1/tickets
→
PATCH
Update a ticket
/api/public/v1/tickets/{ticketId}
→
DELETE
Delete a ticket
/api/public/v1/tickets/{ticketId}
→
POST
Add a comment to a ticket
/api/public/v1/tickets/{ticketId}/comments
→