Apropos Help Center
HomePricingApp
Documentation Changelog API Reference
Contact support
Apropos Public API
Customers
List customers GETCreate a customer POSTGet a customer by ID GETUpdate a customer PATCH
Proposals
List proposals GETGet a proposal by ID GET
Items
List items GETCreate an item POSTGet an item by ID GET
Types
Customer SCHEMACreateCustomerRequest SCHEMAUpdateCustomerRequest SCHEMACustomerEnvelope SCHEMACustomerList SCHEMAProposalStatus SCHEMAProposal SCHEMAProposalEnvelope SCHEMAProposalList SCHEMAItemType SCHEMAItemStatus SCHEMAItem SCHEMACreateItemRequest SCHEMAItemEnvelope SCHEMAItemList SCHEMAError SCHEMAValidationErrorBody SCHEMA
REST API

Customer

Schema

Fields

· 8
id string · uuid required
displayName string required
email string · nullable
companyName string · nullable
phone string · nullable
status string · enum required

values

  • contact
  • lead
  • customer
createdAt string · date-time required
updatedAt string · date-time required

Used by

· 4 operations
GET List customersPOST Create a customerGET Get a customer by IDPATCH Update a customer

Powered by Ferndesk