Jump to Content
Home
API Reference
Home
API Reference
v3
v3.3
v3.4
v3.5
v3.7
v3.8
v3.9
v4.0
Home
API Reference
API Reference
v3.3
API Reference
Market sectors lookup
All
Pages
Start typing to search…
JUMP TO
Synergist REST API v3.3
OVERVIEW
Getting Started
Using the API
Which API to use
API syntax
Structure of an API call
Hashing - Sha512
Key parameters
Error codes
Passing data array to an API request
Record numbers
Encoding special characters
Views
Using views
Table of views
Key field filters
View menus
Sorting
Models
Using data models
Meta-data
ENDPOINTS
Activities API
Activity list
Activity details
Create
Update
Delete
Follow-ups
Add comment
Activity history
Activity type lookup
Client list
Client contact lookup
Owner lookup
Secondary owners
Priority lookup
Status lookup
Team lookup
Time due lookup
Category lookup
Attachments API
Attachments list
Attachment details
Create
Update
Delete
Download - Base64
Calendar API
Users list
Estimates list
Requisitions list
Calendar display
Calendar display compact
Calendar refresh
Show estimate
Hide estimate
Create
Update
Delete
MyCalendar list (deprecated)
MyCalendar list
Checklist header API
Checklist headers list
Create
Update
Delete
Re-order headers
List templates
Hide completed items
Show completed items
Re-order headers
Checklist items API
Checklist items list
Create
Update
Complete item
Delete item
Uncomplete item
Reorder items
Clients API
Client list
Client details
Client financials
Organizations
Create
Update
Delete
Active On
Active Off
Promote to client
Revert to prospect
Put on stop
Put off stop
Countries lookup
Handlers lookup
Sources lookup
Client types lookup
Market sectors lookup
Status grades lookup
Lead ratings lookup
Client contacts API
Contacts list
Contacts details
Create
Update
Delete
Make active
Make inactive
GDPR opt In
GDPR opt out
GDPR verify opt-Ins
GDPR don't verify Opt-Ins
GDPR - update opt outs
Lookup title
Country
Time zone
Companies API
Company list
Company timesheet settings
Estimates API
Estimates list
Expense sheet
Company list
Supplier list
Create
Update
Expense sheet status
Expense sheet print templates
Expense sheet print
Expense sheet copy
Expense sheet submit
Expense sheet approve
Expense sheet unapprove
Expense sheet process
Expense sheet post
Expense sheet all
Expense sheet return
Expense sheet delete
Expense sheet defaults
Expense sheet lines
Expense sheet list
Expense lines
Client list
Jobs list
Phase list
Stages list
Create
Update
Exchange rates/currency codes
Supply types
Attachment view/print
Attachment remove
Attachment open
Attachment upload
Attachment view
Expense line copy
Expense line submit
Expense line approve
Expense line hold
Expense line query
Expense line resubmit
Expense line reject
Expense sheet line
Expense line delete
Job API
Jobs list
Job details
Costs and charges
Create
Update
Promote
Job sales status
Job client list
Job client contact
Job project
Job campaign (sub project)
Jobtype list
Job handler list
Job team list
Kanban API
Kanban board list
Kanban single board header
Kanban board columns
Kanban board entities
To move an entity
Phase API
Phase list
Phase details
Costs and charges
Purchasing API
Purchase order list
Purchase details
Create
Update
Delete
Approve
UnApprove
Promote (make real)
Cancel
Pick
Option
Investment
Change currency
Change supplier
Supplier list
Supply types
Expenses list
Orderers list
Currencies
Job list with currency
Purchase order descriptions
Print purchase order
List print templates/files
Supplier contacts
Related invoices
Tax codes
Quotes API
Quote lines list
Thermos API
Thermos list
Timesheets (actuals) API
Timesheet list
Timesheet details
Timesheets (pending) API
Submitted pending timesheets list
Pending timesheets list
Pending timesheets details
Create
Update
Delete
Timesheet summary table
Company settings
Pending timesheet
Pending copy
Pending submit
Pending resubmit
Timer
User jobs list
Company list
Resource list
Material type list
Material list
Activity type list
Workflow Type List
Add job to timesheet
Remove job from timesheet
Print timesheet
Timesheet weekly change
Show/Hide overtime
Timesheet weekly pending list
Timesheet pending list
Timesheet weekly
Material sheet weekly
Clear timers
Timer status
Client list
Jobs list
Phase list
Workflow list
Task description list
Charge code list
Timesheet weekly date
FM TABLES
Users API
User list
System API
System Parameters
Powered by
Market sectors lookup
Ask AI
