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
v4.0
API Reference
Opt Out (GDPR)
All
Pages
Start typing to search…
JUMP TO
Synergist REST API v4.0
OVERVIEW
Which API to use
Getting started with the Synergist API
Using the API
What's new
API syntax
Structure of an API call
REST verbs
Hashing - Sha512
Key parameters
Error codes
Passing data array to an API request
Record versioning
Encoding special characters
Rows & Pages
Views
Using views
Table of views
Data analytics
Job create views
Key field filters
View menus
Sorting
Models
Using data models
Meta-data
ENDPOINTS
Activities API (Tasks)
Activity List
Activity List - Kanban
Activity Details
Create
Update
Delete
Follow Up
Add a comment
Activity History List
Activity Type Lookup
Client List
Client Contact Lookup
Owner Lookup
Resources lookup
Secondary Owners
Priority Lookup
Status Lookup
Team Lookup
Time Due Lookup
Category Lookup
Attachments API
Attachments List
Attachment Details
Create
Update
Delete
Attachment Print - Base64
Billing plan API
Billing Plan List
Billing Plan Details
Calendar API (Resource bookings)
Users List
Estimates List
Requisitions List
Calendar Display Compact
Calendar Display
Calendar Loading
Calendar Refresh
Show Estimate
Hide Estimate
Create
Update
Delete
MyCalendar List
MyCalendar List (Deprecated)
Campaigns API
Campaign List
Campaign details
Create
Update
Delete
Checklist Header API
Checklist Headers List
Create
Update
Delete
Reorder Headers
List Templates
Hide Completed Items
Show Completed Items
Checklist items API
Checklist Items List
Create
Update
Delete Item
Complete Item
Uncomplete Item
Reorder Items
Clients API (Organisations)
Client List
Client Details
Client Financial
Organizations
Create
Update
Delete
Active On
Active Off
Promote
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
Opt In (GDPR)
Opt Out (GDPR)
Verify Opt-In (GDPR)
Don't Verify Opt-In (GDPR)
Lookup Titles
Lookup Countries
Companies API
Company List
Company Timesheet Settings
Data viewer API (Data analytics)
Running a data viewer report
Start
Check status
DRA API
DRA list
DRA Details
Estimates (time) API
Estimate list
Estimate details
Estimated units
Estimates List (deprecated)
Expense Sheet
Company List
Supplier List
Create
Update
Expense Sheet Status
Expense Sheet Print Templates
Expense Sheet Print (Base64)
Expense Sheet Print (Create a file)
Expense Sheet Copy
Expense Sheet Defaults
Expense Sheet Lines
Expense Sheet Submit Single
Expense Sheet Submit Multi
Expense Sheet Approve Single
Expense Sheet Approve Multi
Expense Sheet Unapprove Single
Expense Sheet Unapprove Multi
Expense Sheet Process Single
Expense Sheet Process Multi
Expense Sheet Post Single
Expense Sheet Post Multi
Expense Sheet All Single
Expense Sheet All Multi
Expense Sheet Return Single
Expense Sheet Return Multi
Expense Sheet Delete Single
Expense Sheet Delete Multi
Expense Sheet List Single
Expense Sheet List Multi
Expense Sheet List All
Expense Lines
Client List
Jobs List
Phase List
Stages List
Create
Update
Exchange Rates
Currency Codes
Supply Types
Supply Types List
Attachment View
Attachment Remove
Attachment Open
Attachment Upload
Expense Line Copy
Expense Line Submit
Expense Line Submittable
Expense Line Approve
Expense Line Hold
Expense Line Query
Expense Line Resubmit
Expense Line Reject
Expense Sheet Line
Expense Line Delete Single
Expense Line Delete Multi
Exchange rates list
Invoices API
Invoice List
Invoice Details
Job API
Jobs List
Job Details
Job Financials
Job Dates
Costs and Charges
Create
Update
Complete
Un-complete
Delete
Job Sales Status
Job Client List
Job Client Contact
Job Project
Job Campaign (Sub Project)
Job Type List
Job Handler List
Job Team List
Kanban API
Kanban Board List
Kanban Single Board Header
Kanban Board Columns
Kanban Board Entities
Kanban Move Entity
Kanban Activity Types
Lookup & Custom field properties API
Lookup properties list
Lookup properties details
Lookups - filtered by parent
Lookups & Custom fields API
Lookups list
Lookups details
Create
Create - with parent context
Phase API
Phase List
Phase Details
Phase Financials
Phase Dates
Costs and Charges
Complete
Un-complete
Update
Update dates
Projects API
Projects List
Projects Details
Create
Update
Delete
Purchase invoices
Purchase Invoices List
Purchase Invoice Details
Purchasing API
Purchase List
Purchase Details
Create
Update
Delete
Expense Sheet List Single
Approve
Unapprove
Promote (Make Real)
Cancel
Quote Pick On
Quote Pick Off
Estimate Pick On
Estimate Pick Off
Option On
Option Off
Investment On
Investment Off
Change Currency
Change Supplier
Supplier List
Expenses List
Supply Types
Orderers List
Currencies
Job List
Purchase Order Descriptions
Print purchase order (Base64)
Print purchase order (Create a file)
List Print Templates / Files
Supplier Contacts
Related Invoices
Tax Codes
Quotes API
Quote Lines List
Suppliers API
Supplier list
Supplier Details
Supplier Financial Details
Create
Update
Delete
Supplier Contacts API
Contact List
Contact Details
Create
Update
Delete
Make Active
Make Inactive
Titles
Countries
Thermos API
Thermos List
Timesheets (actuals) API
Timesheet List
Timesheet Details
Delete
Timesheets (Pending) API
Pending Timesheets List
Pending Timesheets Details
Submitted Pending Timesheets List
Create
Update
Delete
Timesheet Summary Table
Company Settings
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 Overtime
Hide Overtime
Timesheet Weekly Pending List
Timesheet Pending List
Timesheet Weekly
Material Sheet Weekly
Clear Timers
Timer Status
Clients List
Jobs List
Phases List
Workflows List
Task Descriptions List
Charge Code List
Timesheet Weekly Date
Submitted Pending Timesheets List
Workflow API
Workflow list (schedule of stages)
Workflow details (stage)
Create
Update
Delete
Complete stage
Un-complete stage
FM TABLES
Deletion tracking API
Deletion tracking list
Staff resources API
Resources List
Resource - full details
Users API
User list
User list (minimum)
User list (timesheetweeklysettings)
User list (calendarsettings)
User settings
User details
Stages API
Stages List
System API
System Parameters
Powered by
Opt Out (GDPR)
Ask AI
