Staff
Client
Contractor
View Companies

This call returns a list of Companies based on the filters specified. The fields parameter allows you to choose which data fields to return for each Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: code,name,type
Fields to return.
  • Comma separated list of any of the following:
    • address
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • code
    • contacts
    • email
    • fax
    • image
    • lastmodified
    • name
    • phone
    • tags
    • type
    • website
    Example: code,name,phone

OPTIONAL PARAMETERS:

contactdetails
default: false
Contact Details.
  • true - Return email, image, phone for contacts
  • false - Do not return email, image, phone for contacts

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Companies where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Companies where ANY of the specified apifields match
  • all - Companies where ALL of the specified apifields match
divisionid
Division ID (Advanced plan only).
  • divisionid - Companies in specified Division
    Example: 1
id
List of Company IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Companies with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Companies with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Companies added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Companies added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Companies
  • false - Active Companies
search
Search string.
  • string - Companies where Name or Code contains string
    Example: website
  • !string - Companies where Name and Code do not contain string
    Example: !layout
searchcode
Search string.
  • string - Companies where Code contains string
    Example: website
  • !string - Companies where Code does not contain string
    Example: !layout
searchemail
Search string.
  • string - Companies where Email contains string
    Example: website
  • !string - Companies where Email does not contain string
    Example: !layout
searchname
Search string.
  • string - Companies where Name contains string
    Example: website
  • !string - Companies where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Companies with at least one of the specified Tag ID/s
    Example: 1,2,3
type
Company Type.
  • client - Client Companies
  • contractor - Contractor Companies
  • other - Other Companies
  • staff - Staff Companies

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Companies.
Example: pagenumber=2&pagesize=10 (return Companies 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - Company ID
  • name - Company Name
  • code - Company Code
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Company/Companies

This call adds one or more Companies.
Show Sample POST data

Single Company:
{
   "name":"ABC Ltd",
   "type":"client"
}

Multiple Companies:
[
   {
      "name":"ABC Ltd",
      "type":"client"
   },
   {
      "name":"DEF Co",
      "type":"client"
   },
   {
      "name":"GHI Inc",
      "type":"contractor"
   }
]

REQUIRED PARAMETERS:

name
Company Name.
  • name - Name
    Example: Sample Name
type
Company Type.
  • client - Client Company
  • contractor - Contractor Company
  • other - Other Company

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
code
Company Code.
  • code - Code (abbreviation of Company Name)
    Example: ABC
country
Country.
  • country - Country
    Example: Someland
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
facebook
Facebook URL.
  • facebook - Facebook URL
    Example: http://www.facebook.com/proworkflow
fax
Fax Number.
  • fax - Fax Number
    Example: 0123 456 7890
imagecontent
Image.
  • imagecontent - Image Data (Base64 encoded 80x80px png image)
    IMPORTANT: Not available when adding multiple companies, an image larger than 100KB will not be added
linkedin
LinkedIn URL.
  • linkedin - LinkedIn URL
    Example: http://www.linkedin.com/proworkflow
phone
Phone number.
  • phone - Phone number
    Example: 0123 456 7890
state
State.
  • state - State
    Example: Somewhere
tagid
Tag ID or List of Tag IDs.
  • tagid - Tag ID/s
    Example: 1,2,3
twitter
Twitter URL.
  • twitter - Twitter URL
    Example: http://twitter.com/proworkflow
website
Website.
  • website - Website
    Example: www.proworkflow.com
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Company

This call returns details of a single Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Company

This call deletes a Company and optionally the associated Contacts, if you do not delete the Contacts then you must assign them to a new Company afterwards or they will not be usable in the main application.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

deletecontacts
default: true
Delete Company Contacts.
  • true - Delete Company Contacts
  • false - Keep Company Contacts

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit a Company

This call updates a single Company.
IMPORTANT: If the Company Type is changed then all Contacts belonging to the Company will be changed as well. (This is only possible when the Contacts are not assigned to any existing Projects/Tasks.) Show Sample PUT data

{
   "name":"ABC Ltd",
   "code":"ABC"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
code
Company Code.
  • code - Code (abbreviation of Company Name)
    Example: ABC
country
Country.
  • country - Country
    Example: Someland
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
facebook
Facebook URL.
  • facebook - Facebook URL
    Example: http://www.facebook.com/proworkflow
fax
Fax Number.
  • fax - Fax Number
    Example: 0123 456 7890
imagecontent
Image.
  • imagecontent - Image Data (Base64 encoded 80x80px png image)
    IMPORTANT: An image larger than 100KB will not be added
linkedin
LinkedIn URL.
  • linkedin - LinkedIn URL
    Example: http://www.linkedin.com/proworkflow
name
Company Name.
  • name - Name
    Example: Sample Name
phone
Phone number.
  • phone - Phone number
    Example: 0123 456 7890
state
State.
  • state - State
    Example: Somewhere
twitter
Twitter URL.
  • twitter - Twitter URL
    Example: http://twitter.com/proworkflow
website
Website.
  • website - Website
    Example: www.proworkflow.com
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Contacts for a Company

This call returns a list of Contacts for a Company. The fields parameter allows you to choose which data fields to return for each Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,company,type
Fields to return, only Staff contacts view * fields.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • address
    • company
    • email*
    • groups* (Advanced plan only)
    • image
    • lastmodified
    • location* (returns latitude, longitude and locationtime - the time the location was last updated)
    • logindetails* (returns allowlogin and username)
    • name
    • phone
    • *
    • tags*
    • teams* (Advanced plan only)
    • title*
    • type
    Example: name,email,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

allowlogin
Login status.
  • true - Contacts with Login Access
  • false - Contacts without Login Access
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Contacts where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Contacts where ANY of the specified apifields match
  • all - Contacts where ALL of the specified apifields match
idfrom
Contacts with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Contacts with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Contacts added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Contacts added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Contacts
  • false - Active Contacts
search
Search string.
  • string - Contacts where Name or Email contains string
    Example: website
  • !string - Contacts where Name and Email do not contain string
    Example: !layout
searchemail
Search string.
  • string - Contacts where Email Address contains string
    Example: website
  • !string - Contacts where Email Address does not contain string
    Example: !layout
searchname
Search string.
  • string - Contacts where Name contains string
    Example: website
  • !string - Contacts where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Contacts with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Contacts.
Example: pagenumber=2&pagesize=10 (return Contacts 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: firstname
Sort field.
  • id - Contact ID
  • firstname - Contact First Name
  • lastname - Contact Last Name
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Contact/s to a Company

This call adds one or more Contacts to a Company.
Show Sample POST data

Single Contact:
{
   "firstname":"Adam",
   "lastname":"West"
}

Multiple Contacts:
[
   {
      "firstname":"Adam",
      "lastname":"West"
   },
   {
      "firstname":"Bob",
      "lastname":"East"
   },
   {
      "firstname":"Charles",
      "lastname":"South"
   }
]

REQUIRED PARAMETERS:

firstname
First Name.
  • firstname - First Name
    Example: Adam
lastname
Last Name.
  • lastname - Last Name
    Example: West

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
allowlogin
Allow Login Access.
  • true - Grant login access
  • false - Deny login access
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
country
Country.
  • country - Country
    Example: Someland
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
facebook
Facebook URL.
  • facebook - Facebook URL
    Example: http://www.facebook.com/proworkflow
fax
Fax Number.
  • fax - Fax Number
    Example: 0123 456 7890
groupid
Group ID or List of Group IDs. (Advanced plan only).
  • groupid/s - Group ID/s
    Example: 1,2,3
linkedin
LinkedIn URL.
  • linkedin - LinkedIn URL
    Example: http://www.linkedin.com/proworkflow
mobilephone
Mobile Phone number.
  • mobilephone - Mobile Phone Number
    Example: 0123 456 7890
password
Password (if not specified then one will be generated if allowlogin is 'true')
  • password - Password
    Example: p@55w0rd
roleid
Role ID or List of Role IDs.
  • roleid/s - Role ID/s
    Example: 1,2,3
state
State.
  • state - State
    Example: Somewhere
tagid
Tag ID or List of Tag IDs.
  • tagid - Tag ID/s
    Example: 1,2,3
title
Job Title.
  • title - Title
    Example: CEO
twitter
Twitter URL.
  • twitter - Twitter URL
    Example: http://twitter.com/proworkflow
username
Username (contacts can also login using their email address).
  • username - Username
    Example: adam
workphone
Work Phone number.
  • workphone - Work Phone Number
    Example: 0123 456 7890
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Invoices for a Company

This call returns a list of Invoices for a Company based on the filters specified and optionally subtotals based on the grouping options specified, it also returns the totals of all the returned quotes. The subtotals parameter allows you to return Sub Totals of invoiced amounts. The fields parameter allows you to return individual Invoices and choose which data fields to return for each Invoice. This call does not return details of the individual lines for each Invoice, you can use the specific Invoice call to return that information.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: number,title,company,status,projectid,invoiceddate,duedate,totals
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • company
    • dates (invoiced/due/paid)
    • description
    • duedate
    • emaileddate
    • emailedto
    • grandtotal
    • invoicedby
    • invoiceddate
    • lastmodified
    • number
    • paiddate
    • project (project id/title/number)
    • purchaseordernumber
    • status
    • subtotal
    • taxable
    • taxtotal
    • title
    • totals (sub/tax/grand totals)
    • xero (Staff only, requires Xero integration)
    Example: number,title,totals
  • none - return only Totals/Subtotals
subtotals
Sub Totals - specify required subtotals, if not specified then only Fields/Totals will be returned.
  • Comma separated list of any of the following in the required order:
    • company
    • project
    • status

    • day
    • week
    • month
    • year
    Use the 'subtotalsdateoption' to specify whether to group by invoiced, due or paid date (if week is used then the 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' date will be used as the first day of the week).
    Example: company,month - return Sub Totals of Invoiced amounts for each combination of Company and Month.
    NOTE - Only non-zero Sub Totals will be returned.
    IMPORTANT - To use date grouping options you must specify 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' depending on the option user for 'subtotalsdateoption'.

OPTIONAL PARAMETERS:

subtotalsdateoption
default: invoiced
Sub Totals Date Option - specify the date to group by when using a date option in the 'subtotals' option.
  • invoiced - Group by Invoiced Date
  • due - Group by Due Date
  • paid - Group by Paid Date

FILTER PARAMETERS:

apifields
API Field Value/s.
  • apifieldid,string - An API Field ID and String separated by a comma - Invoices where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Invoices where ANY of the specified apifields match
  • all - Invoices where ALL of the specified apifields match
duedatefrom
Invoices due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Invoices due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
grandtotal
Invoice grandtotal.
  • number - Invoice Invoice Grand Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Grand Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Grand Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
idfrom
Invoices with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Invoices with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiceddatefrom
Invoices created on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
invoiceddateto
Invoices created on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
lastmodifiedfrom
Invoices added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Invoices added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
paiddatefrom
Invoices paid on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
paiddateto
Invoices paid on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
searchnumber
Search string.
  • string - Invoices where Number contains string
    Example: website
  • !string - Invoices where Number does not contain string
    Example: !layout
searchtitle
Search string.
  • string - Invoices where Title contains string
    Example: website
  • !string - Invoices where Title does not contain string
    Example: !layout
status
default: unpaid
Invoice Status.
  • paid - Paid Invoices
  • unpaid - Unpaid Invoices
  • all - All Invoices
subtotal
Invoice Sub Total.
  • number - Invoice Sub Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Sub Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Sub Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
taxable
default: all
Taxable status.
  • true - Taxable Invoices
  • false - Non-Taxable Invoices
  • all - All Invoices
taxtotal
Invoice Tax Total.
  • number - Invoice Invoice Tax Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Tax Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Tax Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Invoices.
Example: pagenumber=2&pagesize=10 (return Invoices 11-20). (Paging options are not available if you are using the 'subtotals' option)
  • pagenumber
pagesize
Page Size (must be used with pagenumber). (Paging options are not available if you are using the 'subtotals' option)
  • pagesize
sortby
default: number
Sort field.
  • id - Invoice ID
  • number - Invoice Title
  • title - Invoice Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Notes for a Company

This call returns a list of Notes for a Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

search
Search string.
  • string - Notes that contain string
  • !string - Notes that do not contain string
    Example: !layout

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Notes.
Example: pagenumber=2&pagesize=10 (return Notes 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: date
Sort field.
  • id - Note ID
  • date - Note Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Note to a Company

This call adds a Note to a Company.
Show Sample POST data

{
   "content":"Example Content"
}

REQUIRED PARAMETERS:

content
Content.
  • content - Content
    Example: Sample Note

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Note for a Company

This call returns a single Note for a Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Note from a Company

This call deletes a Note from a Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Projects for a Company

This call returns a list of Projects for a Company based on the specified filters. The fields parameter allows you to choose which data fields to return for each Project.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,number,startdate,duedate
Fields to return.
  • Comma separated list of any of the following:
    • accountedfor (Accounted For Status - true/false)
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • category
    • company (for internal Projects in the Advanced plan, this will also return internalclientteamid, internalclientteamname, internalclientgroupid and internalclientgroupname)
    • completedate
    • contacts (returns clients/contractors/manager/staff)
    • customfields (Advanced plan only)
    • customform (Advanced plan only)
    • customstatus (Advanced plan only)
    • dates (returns start/due/complete)
    • description
    • duedate
    • expensestotal
    • group (Advanced plan only)
    • invoiced (Invoiced Status - true/false)
    • invoicetotal
    • lastmodified
    • manager
    • number
    • paid (Paid Status - true/false)
    • percentcomplete (percentage of tasks completed, heading tasks excluded)
    • priority
    • privatenotes (staff only)
    • quotetotal
    • startdate
    • status
    • team (Advanced plan only)
    • timeallocated
    • timetracked
    • title
    • type
    • (Advanced plan only, returns 'internal' or 'external')
    Example: number,title,company

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

accountedfor
default: all
Accounted For Status.
  • accountedfor - Projects marked as Accounted For
  • unaccountedfor - Projects marked as Unaccounted For
  • all - All Projects
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Projects where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Projects where ANY of the specified apifields match
  • all - Projects where ALL of the specified apifields match
categoryid
Category ID or List of Category IDs.
  • categoryid/s - Projects in specified Category/ies
    Example: 1,2,3
  • !categoryid/s - Projects NOT in specified Category/ies
    Example: !1,2,3
completedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
completedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter)
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter)
    Example: !1,2
  • me - Projects assigned to Contact making request
  • all - All Projects
contactsmode
default: any
Mode used for the contacts parameter.
  • any - Projects assigned to ANY of the specified contacts
  • all - Projects assigned to ALL of the specified contacts
customfields
Custom Field Value/s (Advanced plan only)
  • customfieldid,string - A Custom Field ID and String separated by a comma (Example: 2,Europe) - Projects where the field matches the specified string
    Example: 2,Europe
  • Multiple Custom Field ID and String pairs separated by two pipe characters
    Example: 2,Europe||3,Industrial||3,Commercial
    NOTE: The same Custom Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
customfieldsmode
default: any
Mode used for the customfields parameter.
  • any - Projects where ANY of the specified customfields match
  • all - Projects where ALL of the specified customfields match
customstatusid
Custom Status ID or List of Custom Status IDs (Advanced plan only).
  • customstatusid/s - Projects with specified Custom Status/es
    Example: 1,2
  • !customstatusid/s - Projects without specified Custom Status/es
    Example: !1,2
duedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
groupid
Group (Advanced plan only).
  • groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s
    Example: 1,2
  • !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s
    Example: !1,2
idfrom
Projects with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Projects with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiced
default: all
Invoiced Status.
  • invoiced - Projects marked as Invoiced
  • uninvoiced - Projects marked as Uninvoiced
  • all - All Projects
invoicetotal
Projects where Invoice Total matches criteria.
  • number - Invoice Total is EXACTLY the specified value
    Example: 300
  • gtenumber - Invoice Total is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Invoice Total is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Invoice Total is GREATER THAN Quote Total (Projects with 0 Quote Total ignored)
  • under - Invoice Total is LESS THAN OR EQUAL TO Quote Total (Projects with 0 Quote Total ignored)
  • gtenumber% - Invoice Total is GREATER THAN OR EQUAL to specified percentage of Quote Total (Projects with 0 Quote Total ignored)
    Example: gte30%
  • ltenumber% - Invoice Total is LESS THAN OR EQUAL to specified percentage of Quote Total (Projects with 0 Quote Total ignored)
    Example: lte30%
lastmodifiedfrom
Projects added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Projects added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
managerid
default: all
Manager.
  • managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s
    Example: 1,2
  • !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s
    Example: !1,2
  • me - Projects Managed by Contact making request
  • all - All Projects
paid
default: all
Paid Status.
  • paid - Projects marked as Paid
  • unpaid - Projects marked as Unpaid
  • all - All Projects
priority
Priority or List of Priorities (1-5 representing Very High-Very Low).
  • priority/ies - Projects with specified Priority/ies
    Example: 1,2
  • !priority/ies - Projects NOT with specified Priority/ies
    Example: !4,5
quotetotal
Projects where Quote Total matches criteria.
  • number - Quote Total is EXACTLY the specified value
    Example: 300
  • gtenumber - Quote Total is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Quote Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
search
Search.
  • string - Projects where Number or Title contains string
    Example: website
  • !string - Projects where Number and Title do not contain string
    Example: !layout
searchcustomform
Search Custom Form (Advanced plan only).
  • string - Projects where Custom Form contains string
    Example: website
  • !string - Projects where Custom Form does not contain string
    Example: !layout
searchdescription
Search Description.
  • string - Projects where Description contains string
    Example: website
  • !string - Projects where Description does not contain string
    Example: !layout
searchnumber
Search Name.
  • string - Projects where Number contains string
    Example: website
  • !string - Projects where Number does not contain string
    Example: !layout
searchtitle
Search Title.
  • string - Projects where Title contains string
    Example: website
  • !string - Projects where Title does not contain string
    Example: !layout
startdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
startdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
status
default: active
Status.
  • active - Active Projects
  • complete - Completed Projects
  • all - All Projects
teamid
Team (Advanced plan only).
  • teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s
    Example: 1,2
  • !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s
    Example: !1,2
timeallocated
Time Allocated.
  • number - Time Allocated (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber - Time Allocated (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Time Allocated (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
timebillable
default: all
Billable/Non-billable/All Time Tracked.
  • all - All Time
  • billable - Billable Time only
  • nonbillable - Non-billable Time only
timetracked
Projects where Time Tracked matches criteria.
timetrackedby, timetrackedfrom, timetrackedto and timebillable parameters will apply to the starred options.
IMPORTANT: The non-starred options will always use the Total Time Tracked (all contacts, dates, billable status) for comparison.
  • number* - Time Tracked (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber* - Time Tracked (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber* - Time Tracked (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Total Time Tracked is GREATER THAN Allocated Time
  • under - Total Time Tracked is LESS THAN OR EQUAL TO Allocated Time
  • gtenumber% - TOTAL Time Tracked is GREATER THAN OR EQUAL to specified percentage of Allocated Time
    Example: gte30%
  • ltenumber% - TOTAL Time Tracked is LESS THAN OR EQUAL to specified percentage of Allocated Time
    Example: lte30%
timetrackedby
default: all
Time Tracked By.
  • contactid/s - Contact ID or List of Contact IDs - Time Tracked by specified Contact/s
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Time NOT Tracked by specified Contact/s
    Example: !1,2
  • me - Time Tracked by Contact making request
  • all - All Time Tracked
timetrackedfrom
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
timetrackedto
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Projects.
Example: pagenumber=2&pagesize=10 (return Projects 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: number
Sort field.
  • id - ID
  • title - Title
  • number - Number
  • startdate - Start Date
  • duedate - Due Date
  • completedate - Complete Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Project

This call adds a Project for a Company. In the Advanced Plan you may specify templateid to use a Project Template (any values you provide will override those in the Project Template). In the Advanced Plan you must specify groupid if the managerid belongs to more than 1 group.
Show Sample POST data

{
   "title":"Sample Project",
   "number":"auto",
   "description":"Sample Project Description",
   "managerid":"me",
   "staff":"2,3,5",
   "clients":"6,7",
   "contractors":"9,10",
   "priority":2,
   "startdate":"2014-04-18",
   "duedate":"2014-04-28",
   "customfields":[
      {
         "id":1,
         "value":"Europe"
      },
      {
         "id":2,
         "value":"Industrial"
      }
   ]
}

REQUIRED PARAMETERS:

title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
autonumberid
Autonumbering Option ID (Advanced Plan only, required if Advanced autonumbering is enabled and the Team of 'managerid' has more than one Autonumber option. The 'settings/projects/autonumbering' call returns a list of available IDs.).
  • autonumberid - Autonumbering Option ID
    Example: 1
categoryid
Project Category ID.
  • categoryid - Category ID
    Example: 1
clientaccess
Client Access (true/false to set whether Client can View this Project).
  • true - Client can View Project
  • false - Client cannot View Project
clients
Assigned Clients.
  • clients - Contact ID or List of Contact IDs
    Example: 1,2,3
completedate
Complete Date, if specified then the Project will be added with a Completed status (alerts are not sent when adding Completed Projects).
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
contractors
Assigned Contractors.
  • contractors - Contact ID or List of Contact IDs
    Example: 1,2,3
customfields
Custom Field Value/s (Advanced plan only)
  • customfields - Custom Fields
    You must specify id and value (use the settings/projects/customfields call for a list of ids and values).
    Example:
    "customfields":
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
customformcontent
Custom Form Content (Advanced plan only).
  • customformcontent - Custom Form Content
    Example: Sample Form Content
customformtitle
Custom Form Title (Advanced plan only).
  • customformtitle - Custom Form Title
    Example: Sample Form Title
customstatusid
Custom Status ID (Advanced plan only).
  • customstatusid - Custom Status ID
    Example: 1
description
Description.
  • description - Description
    Example: Sample Description
duedate
Due Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
emailalerts
Email Alerts (true/false to set whether Email Alerts are sent for activity in this Project).
  • true - Send Email Alerts
  • false - Don't Send Email Alerts
groupid
Group ID (Advanced Plan only, required if managerid belongs to more than 1 Group).
  • groupid - Group ID
    Example: 1
invoicetotal
Invoiced Value.
  • invoicetotal - Invoiced Value
    Example: 1000.00
  • auto - Total of Project Invoices
managerid
default: me
Manager ID.
  • managerid - Manager Contact ID
    Example: 1
  • me - Contact making request
number
default: auto
Number.
  • number - Number
    Example: ABC-00001
  • auto - Use Autonumbering
priority
Priority (1-5 representing Very High-Very Low).
  • priority - Priority
    Example: 1
privatenotes
Private Notes (Visible to Staff only).
  • privatenotes - Private Notes
    Example: Sample Private Notes
quotetotal
Quoted Value.
  • quotetotal - Quoted Value
    Example: 1000.00
  • auto - Total of Project Quotes
staff
Assigned Staff.
  • staff - Contact ID or List of Contact IDs
    Example: 1,2,3
  • me - Contact making request
startdate
Start Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
templateid
Template ID (Advanced plan only).
  • templateid - Project Template ID
    Example: 1
timeallocated
Time Allocated.
  • number - Time Allocated (minutes)
    Example: 300

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Quotes for a Company

This call returns a list of Quotes for a Company based on the filters specified and optionally subtotals based on the grouping options specified, it also returns the totals of all the returned quotes. The subtotals parameter allows you to return Sub Totals of quoted amounts. The fields parameter allows you to return individual Quotes and choose which data fields to return for each Quote. This call does not return details of the individual lines for each Quote, you can use the specific Quote call to return that information.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: number,title,status,projectid,quoteddate,totals
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • approveddate
    • company
    • dates (quoted/valid to/approved)
    • description
    • emaileddate
    • emailedto
    • lastmodified
    • number
    • project (project id/title/number)
    • quotedby
    • quoteddate
    • status
    • taxable
    • title
    • totals
    • type
    • validtodate
    Example: number,title,company
  • none - return only Totals/Subtotals
subtotals
Sub Totals - specify required subtotals, if not specified then only Fields/Totals will be returned.
  • Comma separated list of any of the following in the required order:
    • company
    • project
    • status

    • day
    • week
    • month
    • year
    Use the 'subtotalsdateoption' to specify whether to group by approved or quoted date (if week is used then the 'approveddatefrom' or 'quoteddatefrom' date will be used as the first day of the week).
    Example: company,month - return Sub Totals of Quoted amounts for each combination of Company and Month.
    NOTE - Only non-zero Sub Totals will be returned.
    IMPORTANT - To use date grouping options you must specify 'approveddatefrom' or 'quoteddatefrom' depending on the option user for 'subtotalsdateoption'.

OPTIONAL PARAMETERS:

subtotalsdateoption
default: quoted
Sub Totals Date Option - specify the date to group by when using a date option in the 'subtotals' option.
  • approved - Group by Approved Date
  • quoted - Group by Quoted Date

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Quotes where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Quotes where ANY of the specified apifields match
  • all - Quotes where ALL of the specified apifields match
approveddatefrom
Quotes approved on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
approveddateto
Quotes approved on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
grandtotal
Quote grandtotal.
  • number - Quote Grand Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Quote Grand Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Quote Grand Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
idfrom
Quotes with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Quotes with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Quotes added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Quotes added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
quoteddatefrom
Quotes created on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
quoteddateto
Quotes created on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
search
Search string.
  • string - Quotes where Number or Title contains string
    Example: website
  • !string - Quotes where Number and Title do not contain string
    Example: !layout
searchnumber
Search string.
  • string - Quotes where Number contains string
    Example: website
  • !string - Quotes where Number does not contain string
    Example: !layout
searchtitle
Search string.
  • string - Quotes where Title contains string
    Example: website
  • !string - Quotes where Title does not contain string
    Example: !layout
status
default: pending
Quote Status.
  • pending - Pending Quotes
  • approved - Approved Quotes
  • active - Pending and Approved Quotes
  • declined - Declined Quotes
  • all - All Quotes
subtotal
Quote Sub Total.
  • number - Quote Sub Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Quote Sub Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Quote Sub Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
taxable
default: all
Taxable status.
  • true - Taxable Quotes
  • false - Non-Taxable Quotes
  • all - All Quotes
taxtotal
Quote Tax Total.
  • number - Quote Tax Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Quote Tax Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Quote Tax Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
type
default: all
Quote Type.
  • estimate - Estimates
  • quote - Quotes
  • all - Estimates and Quotes
validtodatefrom
Quotes valid to/after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
validtodateto
Quotes valid to/before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Quotes.
Example: pagenumber=2&pagesize=10 (return Quotes 11-20). (Paging options are not available if you are using the 'subtotals' option)
  • pagenumber
pagesize
Page Size (must be used with pagenumber). (Paging options are not available if you are using the 'subtotals' option)
  • pagesize
sortby
default: number
Sort field.
  • id - Quote ID
  • number - Quote Title
  • title - Quote Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Company Summary

This call returns a list of Contacts, Invoices, Projects, Quotes and Tasks for the specified Company. Limited data is returned for each item and this call is not intended to replace the individual calls which offer much more extensive options.

Instead, this call is designed to be used when you need to fetch a summary of contacts and current activity for a Company.

By default this will return the first 10 results for each of the following (assuming the user has the relevant permission):

Contacts: Name, Company, Email, Phone and ID - Client/Contractor/Staff Companies
Invoices: Number, Title, Company, Totals and ID (Unpaid Invoices) - Client Companies Only
Projects: Number, Title, Company and ID (Active Projects) - Client Companies Only
Quotes: Number, Title, Company, Totals and ID (Pending Quotes) - Client Companies Only
Tasks: Name, Order, Project and ID (Active Tasks) - Client Companies Only

REQUIRED PARAMETERS:

FIELD PARAMETERS:

types
default: all
Data Types to return.
  • all - Return all data types
  • Comma separated list of any of the following:
    • contacts
    • invoices
    • projects
    • quotes
    • tasks
    Example: contacts,projects

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

pagenumber
default: 1
Page Number (must be used with pagesize) to return a subset of each Data Type.
Example: pagenumber=2&pagesize=10 (return rows 11-20).
  • pagenumber
pagesize
default: 10
Page Size (must be used with pagenumber).
  • pagesize
Staff
Client
Contractor
View Tags for a Company

This call returns a list of tags for a Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Add/Remove Tags for a Company

This call adds or removes tags for a Company.

REQUIRED PARAMETERS:

tagid
Tags to Add/Remove.
  • tags - Tag ID or List of Tag IDs
    Example: 1,2,3

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

remove
default: false
Set as 'true' to remove Tags (default is to add them).
  • true - Remove Tags from Company
  • false - Add Tags to Company

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Tasks for a Company

This call returns a list of Tasks for a Company based on the specified filters. The fields parameter allows you to choose which data fields to return for each Task.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,type,order,status,project,startdate,duedate
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • billable
    • category
    • company
    • completedate
    • contacts
    • creator
    • (contact who added this Task)
    • dates (returns start/due/complete)
    • dependent (returns dependent/current status)
    • description
    • duedate
    • lastmodified
    • name
    • order
    • priority
    • project
    • (returns ID/Number/Title)
    • projectcategory
    • (returns ID/Name)
    • projectmanager
    • (returns ID/Name)
    • startdate
    • status
    • timeallocated
    • timetracked
    • type
    Example: order,name,project

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Tasks where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Tasks where ANY of the specified apifields match
  • all - Tasks where ALL of the specified apifields match
billable
default: all
Billable status.
  • true - Billable Tasks
  • false - Non-Billable Tasks
  • all - All Tasks
categoryid
Category.
  • categoryid/s - General Tasks in specified Category/ies
    Example: 1,2
  • !categoryid/s - General Tasks NOT in specified Category/ies
    Example: !1,2
completedatefrom
Tasks completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
completedateto
Tasks completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Tasks assigned to ANY/ALL specified Contact/s (see contactsmode parameter)
    Example: 1,2
  • me - Tasks assigned to Contact making request
  • unassigned - Unassigned Tasks
  • all - All Tasks
contactsmode
default: any
Mode used for the contacts parameter.
  • any - Tasks assigned to ANY of the specified contacts
  • all - Tasks assigned to ALL of the specified contacts
dependentstatus
Task Dependent Status - Using this filter will only return Dependent Tasks that meet the specified status.
  • current - Current Dependent Tasks
  • noncurrent - Non-Current Dependent Tasks
  • all - All Dependent Tasks
duedatefrom
Tasks due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Tasks due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
generaltasks
default: true
General Tasks.
  • true - Include General Tasks
  • false - Exclude General Tasks
idfrom
Tasks with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Tasks with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Tasks added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Tasks added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
managerid
Manager.
  • managerid/s - Contact ID or List of Contact IDs - Tasks in Projects managed by specified Contact/s
    Example: 1,2
  • me - Tasks in Projects managed by Contact making request
priority
Priority (1-5 representing Very High-Very Low).
  • priority/ies - Tasks with specified Priority/ies
    Example: 1,2
  • !priority/ies - Tasks NOT with specified Priority/ies
    Example: !4,5
projectcategoryid
Project Category ID or List of Project Category IDs.
  • projectcategoryid/s - Tasks in Projects in specified Category/ies
    Example: 1,2,3
projectcompletedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectcompletedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectid
Project.
  • projectid/s - Tasks in specified Project/s
    Example: 1,2
projectstartdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstartdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstatus
default: all
Project Status.
  • active - Tasks in Active Projects
  • complete - Tasks in Completed Projects
  • all - Tasks in All Projects
projecttasks
default: true
Project Tasks.
  • true - Include Project Tasks
  • false - Exclude Project Tasks
searchdescription
Search Description.
  • string - Tasks where Description contains string
    Example: website
  • !string - Tasks where Description does not contain string
    Example: !layout
searchname
Search Name.
  • string - Tasks where Name contains string
    Example: website
  • !string - Tasks where Name does not contain string
    Example: !layout
startdatefrom
Tasks starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
startdateto
Tasks starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
status
default: active
Task Status.
  • active - Active Tasks
  • complete - Completed Tasks
  • all - All Tasks
timeallocated
Time Allocated.
  • number - Time Allocated (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber - Time Allocated (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Time Allocated (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
timetracked
Tasks where Time Tracked matches criteria.
timetrackedby, timetrackedfrom, timetrackedto parameters apply to the starred options.
  • number* - Time Tracked (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber* - Time Tracked (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber* - Time Tracked (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Total Time Tracked is GREATER THAN Allocated Time
  • under - Total Time Tracked is LESS THAN OR EQUAL TO Allocated Time
  • gtenumber% - TOTAL Time Tracked is GREATER THAN OR EQUAL to specified percentage of Allocated Time
    Example: gte30%
  • ltenumber% - TOTAL Time Tracked is LESS THAN OR EQUAL to specified percentage of Allocated Time
    Example: lte30%
timetrackedby
default: all
Time Tracked By.
  • contactid/s - Contact ID or List of Contact IDs - Time Tracked by specified Contact/s
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Time NOT Tracked by specified Contact/s
    Example: !1,2
  • me - Time Tracked by Contact making request
  • all - All Time Tracked
timetrackedfrom
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
timetrackedto
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
type
default: all
Task Type.
  • normal - Normal Tasks
  • bold - Bold Tasks
  • heading - Heading Tasks
  • nonheading - Non-Heading Tasks (Normal + Bold)
  • all - All Tasks

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Tasks.
Example: pagenumber=2&pagesize=10 (return Tasks 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: id
Sort field.
  • id - ID
  • order - Order
  • name - Name
  • startdate - Start Date
  • duedate - Due Date
  • completedate - Complete Date
  • projectid - Project ID
  • projectnumber - Project Number
  • projecttitle - Project Title
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Time Tracked by a Contact

This call returns a the Total time tracked by a Contact based on the filters specified. The subtotals parameter allows you to return Sub Totals of time tracked. The fields parameter allows you to return individual Time Records and choose which data fields to return for each Time Record.

REQUIRED PARAMETERS:

trackedfrom
default: -6d
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
trackedto
default: +0d
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

FIELD PARAMETERS:

fields
Fields to return - if not specified then only Total/Sub Totals will be returned.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • billable
    • category (Project Category)
    • company
    • contact
    • dates
    • lastmodified
    • notes
    • project
    • task
    • tasktimetotals (Total allocated/tracked time for the task)
    • timetracked
    Example: contact,task,timetracked
  • none - return only Total/Subtotals
subtotals
Sub Totals to return - if not specified then only Fields and/or Total will be returned.
  • Comma separated list of any of the following in the required order:
    • billable
    • category
    • company
    • contact
    • group (Advanced plan only, Group in charge of Project)
    • internalclientgroup (Advanced plan only, Group of Internal Client for Project)
    • internalclientteam (Advanced plan only, Team of Internal Client for Project)
    • project
    • task
    • team (Advanced plan only, Team in charge of Project)

    • day
    • week
    • month
    • year
    • If week is used then the 'trackedfrom' date will be used as the first day of the week.
      Example: contact,company - return Sub Totals of Time Tracked for each combination of Contact and Company.
      NOTE - Only non-zero Sub Totals will be returned.

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Time Records where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Time Records where ANY of the specified apifields match
  • all - Time Records where ALL of the specified apifields match
billable
default: all
Billable status.
  • billable - Billable Time
  • nonbillable - Non-Billable Time
  • all - All Time
categoryid
Project Category ID or List of Project Category IDs.
  • categoryid/s - Time for Projects in specified Category/ies
    Example: 1,2
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Time Tracked by specified Contact/s
    Example: 1,2
  • me - Time Tracked by Contact making request
  • all - Time Tracked by All Contact
generaltasks
default: true
General Tasks.
  • true - Include Time for General Tasks
  • false - Exclude Time for General Tasks
idfrom
Time Records with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Time Records with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Time Records added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Time Records added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
projectcompletedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectcompletedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectid
Project ID or List of Project IDs.
  • projectid/s - Time for specified Project/s
    Example: 1,2
projectstartdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstartdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projecttasks
default: true
Project Tasks.
  • true - Include Time for Project Tasks
  • false - Exclude Time for Project Tasks
taskcompletedatefrom
Tasks completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskcompletedateto
Tasks completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskduedatefrom
Tasks due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskduedateto
Tasks due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskid
Task ID or List of Task IDs.
  • taskid/s - Time for specified Task/s
    Example: 1,2
taskstartdatefrom
Tasks starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskstartdateto
Tasks starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

sortby
default: id
Sort field for Time Records.
  • id - Time Record ID
  • date - Time Record Date
  • taskid - Task ID
  • projectid - Project ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Client Companies

This call returns a list of Client Companies based on the specified filters. The fields parameter allows you to choose which data fields to return for each Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,code
Fields to return.
  • Comma separated list of any of the following:
    • address
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • code
    • contacts
    • email
    • image
    • lastmodified
    • name
    • phone
    • tags
    • type
    Example: code,name,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Companies where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Companies where ANY of the specified apifields match
  • all - Companies where ALL of the specified apifields match
divisionid
Division ID (Advanced plan only).
  • divisionid - Companies in specified Division
    Example: 1
idfrom
Companies with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Companies with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Companies added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Companies added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Companies
  • false - Active Companies
search
Search string.
  • string - Companies where Name or Code contains string
    Example: website
  • !string - Companies where Name and Code do not contain string
    Example: !layout
searchcode
Search string.
  • string - Companies where Code contains string
    Example: website
  • !string - Companies where Code does not contain string
    Example: !layout
searchemail
Search string.
  • string - Companies where Email contains string
    Example: website
  • !string - Companies where Email does not contain string
    Example: !layout
searchname
Search string.
  • string - Companies where Name contains string
    Example: website
  • !string - Companies where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Companies with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Companies.
Example: pagenumber=2&pagesize=10 (return Companies 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - Company ID
  • name - Company Name
  • code - Company Code
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Contractor Companies

This call returns a list of Contractor Companies based on the specified filters. The fields parameter allows you to choose which data fields to return for each Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,code
Fields to return.
  • Comma separated list of any of the following:
    • address
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • code
    • contacts
    • email
    • image
    • lastmodified
    • name
    • phone
    • tags
    • type
    Example: code,name,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Companies where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Companies where ANY of the specified apifields match
  • all - Companies where ALL of the specified apifields match
divisionid
Division ID (Advanced plan only).
  • divisionid - Companies in specified Division
    Example: 1
idfrom
Companies with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Companies with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Companies added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Companies added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Companies
  • false - Active Companies
search
Search string.
  • string - Companies where Name or Code contains string
    Example: website
  • !string - Companies where Name and Code do not contain string
    Example: !layout
searchcode
Search string.
  • string - Companies where Code contains string
    Example: website
  • !string - Companies where Code does not contain string
    Example: !layout
searchemail
Search string.
  • string - Companies where Email contains string
    Example: website
  • !string - Companies where Email does not contain string
    Example: !layout
searchname
Search string.
  • string - Companies where Name contains string
    Example: website
  • !string - Companies where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Companies with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Companies.
Example: pagenumber=2&pagesize=10 (return Companies 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - Company ID
  • name - Company Name
  • code - Company Code
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Staff Companies

This call returns a list of Staff Companies. The fields parameter allows you to choose which data fields to return for each Company.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,code
Fields to return.
  • Comma separated list of any of the following:
    • address
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • code
    • contacts
    • email
    • image
    • lastmodified
    • name
    • phone
    • tags
    • type
    Example: code,name,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Companies where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Companies where ANY of the specified apifields match
  • all - Companies where ALL of the specified apifields match
divisionid
Division ID (Advanced plan only).
  • divisionid - Companies in specified Division
    Example: 1
idfrom
Companies with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Companies with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Companies added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Companies added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Companies
  • false - Active Companies
search
Search string.
  • string - Companies where Name or Code contains string
    Example: website
  • !string - Companies where Name and Code do not contain string
    Example: !layout
searchcode
Search string.
  • string - Companies where Code contains string
    Example: website
  • !string - Companies where Code does not contain string
    Example: !layout
searchemail
Search string.
  • string - Companies where Email contains string
    Example: website
  • !string - Companies where Email does not contain string
    Example: !layout
searchname
Search string.
  • string - Companies where Name contains string
    Example: website
  • !string - Companies where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Companies with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Companies.
Example: pagenumber=2&pagesize=10 (return Companies 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - Company ID
  • name - Company Name
  • code - Company Code
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending

DELETE PUT POST GET

Staff
Client
Contractor
View Contacts

This call returns a list of Contacts based on the filters specified. The fields parameter allows you to choose which data fields to return for each Contact. Clients can only view limited details about Staff and Contacts in their Company. Contractors can only view limited details about Staff and themselves.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,company,type
Fields to return, only Staff contacts view * fields.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • address
    • company
    • email*
    • fax*
    • groups* (Advanced plan only)
    • image
    • lastmodified
    • location* (returns latitude, longitude and locationtime - the time the location was last updated)
    • logindetails* (returns allowlogin and username)
    • name
    • phone*
    • roles
    • (returns roles for Staff Contacts)
    • tags*
    • teams* (Advanced plan only)
    • title*
    • type
    Example: name,email,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

allowlogin
Login status.
  • true - Contacts with Login Access
  • false - Contacts without Login Access
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Contacts where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Contacts where ANY of the specified apifields match
  • all - Contacts where ALL of the specified apifields match
companyid
Company ID.
  • companyid - Contacts in specified Company
    Example: 1
divisionid
Division ID (Advanced plan only).
  • divisionid - Contacts in specified Division
    Example: 1
id
List of Contact IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Contacts with ID less than or equal to this value.
  • id - ID
    Example: 1
idto
Contacts with ID greater than or equal to this value.
  • id - ID
    Example: 1
lastmodifiedfrom
Contacts added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Contacts added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Contacts
  • false - Active Contacts
roleid
Role ID or List of Role IDs.
  • roleid/s - Contacts with at least one of the specified Role ID/s
    Example: 1,2,3
search
Search string.
  • string - Contacts where Name or Email contains string
    Example: website
  • !string - Contacts where Name and Email do not contain string
    Example: !layout
searchemail
Search string.
  • string - Contacts where Email Address contains string
    Example: website
  • !string - Contacts where Email Address does not contain string
    Example: !layout
searchname
Search string.
  • string - Contacts where Name contains string
    Example: website
  • !string - Contacts where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Contacts with at least one of the specified Tag ID/s
    Example: 1,2,3
type
Contact Type.
  • client - Client Contacts
  • contractor - Contractor Contacts
  • other - Other Contacts
  • staff - Staff Contacts

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Contacts.
Example: pagenumber=2&pagesize=10 (return Contacts 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: firstname
Sort field.
  • id - Contact ID
  • firstname - Contact First Name
  • lastname - Contact Last Name
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Contact/s.

This call adds one or more Contacts.
Show Sample POST data

Single Contact:
{
   "firstname":"Adam",
   "lastname":"West",
   "type":"client",
   "companyid":1
}

Multiple Contacts:
[
   {
      "firstname":"Adam",
      "lastname":"West",
      "type":"client",
      "companyid":1
   },
   {
      "firstname":"Bob",
      "lastname":"East",
      "type":"client",
      "companyid":2
   },
   {
      "firstname":"Charles",
      "lastname":"South",
      "type":"contractor",
      "companyid":3
   }
]

REQUIRED PARAMETERS:

companyid
Company ID.
  • companyid - Company ID
    Example: 1
firstname
First Name.
  • firstname - First Name
    Example: Adam
lastname
Last Name.
  • lastname - Last Name
    Example: West
type
Contact Type.
  • staff - Staff Contact
  • client - Client Contact
  • contractor - Contractor Contact
  • other - Other Contact

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

addprojectrequest
default: false
Client can add a project request (only applies in Advanced plan for clients).
  • true - Grant permission
  • false - Deny permission
address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
allowlogin
Allow Login Access.
  • true - Grant login access
  • false - Deny login access
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
country
Country.
  • country - Country
    Example: Someland
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
facebook
Facebook URL.
  • facebook - Facebook URL
    Example: http://www.facebook.com/proworkflow
fax
Fax Number.
  • fax - Fax Number
    Example: 0123 456 7890
groupid
Group ID or List of Group IDs. (Staff Contacts in Advanced Plan only)
IMPORTANT: If a Group ID/s is not specified then Staff will be automatically added to Group ID 1.
  • groupid/s - Group ID/s
    Example: 1,2,3
imagecontent
Image.
  • imagecontent - Image Data (Base64 encoded 80x80px png image)
    IMPORTANT: Not available when adding multiple contacts, an image larger than 100KB will not be added
linkedin
LinkedIn URL.
  • linkedin - LinkedIn URL
    Example: http://www.linkedin.com/proworkflow
mobilephone
Mobile Phone number.
  • mobilephone - Mobile Phone Number
    Example: 0123 456 7890
password
Password (if not specified then one will be generated if allowlogin is 'true')
  • password - Password
    Example: p@55w0rd
roleid
Role ID or List of Role IDs (Staff Contacts with Login Access only)
IMPORTANT: If a Role ID/s is not specified then Staff will be automatically setup as Super Users if allowlogin is 'true'.
  • roleid/s - Role ID/s
    Example: 1,2,3
state
State.
  • state - State
    Example: Somewhere
tagid
Tag ID or List of Tag IDs.
  • tagid - Tag ID/s
    Example: 1,2,3
title
Job Title.
  • title - Title
    Example: CEO
twitter
Twitter URL.
  • twitter - Twitter URL
    Example: http://twitter.com/proworkflow
username
Username (contacts can also login using their email address).
  • username - Username
    Example: adam
viewallcompanyprojects
default: false
Client can view all company projects (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewallprojecttasks
default: false
Client can view all project tasks (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewarchivedprojects
default: false
Client can view archived projects (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewcalendar
default: false
Client can view calendar page (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewquotesandinvoices
default: false
Client can view quotes and invoices (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewtimeinformation
default: false
Client can view time information (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewtimeline
default: false
Client can view timeline (only applies for clients).
  • true - Grant permission
  • false - Deny permission
workphone
Work Phone number.
  • workphone - Work Phone Number
    Example: 0123 456 7890
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Contact

This call returns details of a single Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

permissions
default: false
Contact Permissions.
  • true - Return roles & permissions (for staff) or include permissions (for clients & contractors)
  • false - Do not return roles & permissions

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Contact

This call deletes a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit a Contact

This call updates a single Contact.
Show Sample PUT data

{
   "firstname":"Adam",
   "lastname":"West"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

addprojectrequest
Client can add a project request (only applies in Advanced plan for clients).
  • true - Grant permission
  • false - Deny permission
address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
allowlogin
Allow Login Access.
  • true - Grant login access
  • false - Deny login access
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
companyid
Company ID.
  • companyid - Company ID
    Example: 1
country
Country.
  • country - Country
    Example: Someland
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
facebook
Facebook URL.
  • facebook - Facebook URL
    Example: http://www.facebook.com/proworkflow
fax
Fax Number.
  • fax - Fax Number
    Example: 0123 456 7890
firstname
First Name.
  • firstname - First Name
    Example: Adam
groupid
Group ID or List of Group IDs. (Staff Contacts in Advanced Plan only)
  • groupid/s - Group ID/s
    Example: 1,2,3
imagecontent
Image.
  • imagecontent - Image Data (Base64 encoded 80x80px png image)
    IMPORTANT: An image larger than 100KB will not be added
lastname
Last Name.
  • lastname - Last Name
    Example: West
linkedin
LinkedIn URL.
  • linkedin - LinkedIn URL
    Example: http://www.linkedin.com/proworkflow
mobilephone
Mobile Phone Number.
  • mobilephone - Mobile Phone Number
    Example: 0123 456 7890
password
Password (if none is provided then one will be randomly generated if allowlogin is 'true')
  • password - Password
    Example: p@55w0rd
roleid
Role ID or List of Role IDs (Staff Contacts with Login Access only)
  • roleid/s - Role ID/s
    Example: 1,2,3
state
State.
  • state - State
    Example: Somewhere
tagid
Tag ID or List of Tag IDs.
  • tagid - Tag ID/s
    Example: 1,2,3
title
Job Title.
  • title - Title
    Example: CEO
twitter
Twitter URL.
  • twitter - Twitter URL
    Example: http://twitter.com/proworkflow
username
Username (contacts can also login using their email address).
  • username - Username
    Example: adam
viewallcompanyprojects
Client can view all company projects (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewallprojecttasks
Client can view all project tasks (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewarchivedprojects
Client can view archived projects (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewcalendar
Client can view calendar page (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewquotesandinvoices
Client can view quotes and invoices (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewtimeinformation
Client can view time information (only applies for clients).
  • true - Grant permission
  • false - Deny permission
viewtimeline
Client can view timeline (only applies for clients).
  • true - Grant permission
  • false - Deny permission
workphone
Work Phone Number.
  • workphone - Work Phone Number
    Example: 0123 456 7890
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Groups for a Staff Contact

This call returns a list of Teams & Groups for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Add/Remove Staff Contact to/from a Group

This call adds or removes a Contact to/from a Group. Team membership will be automatically updated.

REQUIRED PARAMETERS:

groupid
Groups to Add/Remove Contact to/from.
  • groupds - Group ID or List of Group IDs
    Example: 1,2,3

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

remove
default: false
Set as 'true' to remove from Groups (default is to add to them).
  • true - Remove Contact from Group/s
  • false - Add Contact to Group/s

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Contact's Location

This call returns latitude, longitude and locationtime (when the location was last updated) of a single Contact's Location.
IMPORTANT: Location is not the same as a Contact's Address. Location is used when you need to track a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Update a Contact's Location

This call updates the location of a single Contact, you can specify either Latitude/Longitude OR an Address to be geocoded (converted to a latitude/longitude), an error will be returned if the geocoding fails.
Show Sample POST data

{
   "latitude":43.689060,
   "longitude":-20.182721
}

REQUIRED PARAMETERS:

address
Address
  • address - Address
    Example: 123 ABC Street, Townsville, 91911, USA
latitude
Latitude
  • latitude - Latitude
    Example: 40.689060
longitude
Longitude
  • longitude - Longitude
    Example: -20.182721

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Notes for a Contact

This call returns a list of Notes for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

datefrom
Notes added on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dateto
Notes added on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
search
Search string.
  • string - Notes that contain string
    Example: website
  • !string - Notes that do not contain string
    Example: !layout

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Notes.
Example: pagenumber=2&pagesize=10 (return Notes 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: date
Sort field.
  • id - Note ID
  • date - Note Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Note to a Contact

This call adds a Note to a Contact.
Show Sample POST data

{
   "content":"Example Content"
}

REQUIRED PARAMETERS:

content
Content.
  • content - Content
    Example: Note Content

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Note for a Contact

This call returns a single Note for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Note from a Contact

This call deletes a Note from a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View All Permissions for a Contact

This call returns all permissions for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Check Permission

This call checks a single permission for a Staff contact, use the 'settings/contacts/permissions' call to view a list of permissionids.

REQUIRED PARAMETERS:

permissionsetting
default: view
Permission Setting to check.
  • view - View
  • add - Add
  • edit - Edit
  • delete - Delete

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Projects for a Contact

This call returns a list of Projects for a Contact based on the specified filters. The fields parameter allows you to choose which data fields to return for each Project.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,number,company,startdate,duedate
Fields to return.
  • Comma separated list of any of the following:
    • accountedfor (Accounted For Status - true/false)
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • category
    • company (for internal Projects in the Advanced plan, this will also return internalclientteamid, internalclientteamname, internalclientgroupid and internalclientgroupname)
    • completedate
    • contacts (returns clients/contractors/manager/staff)
    • customfields (Advanced plan only)
    • customform (Advanced plan only)
    • customstatus (Advanced plan only)
    • dates (returns start/due/complete)
    • description
    • duedate
    • expensestotal
    • group (Advanced plan only)
    • invoiced (Invoiced Status - true/false)
    • invoicetotal
    • lastmodified
    • manager
    • number
    • paid (Paid Status - true/false)
    • percentcomplete (percentage of tasks completed, heading tasks excluded)
    • priority
    • privatenotes (staff only)
    • quotetotal
    • startdate
    • status
    • team (Advanced plan only)
    • timeallocated
    • timetracked
    • title
    • type
    • (Advanced plan only, returns 'internal' or 'external')
    Example: number,title,company

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

accountedfor
default: all
Accounted For Status.
  • accountedfor - Projects marked as Accounted For
  • unaccountedfor - Projects marked as Unaccounted For
  • all - All Projects
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Projects where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Projects where ANY of the specified apifields match
  • all - Projects where ALL of the specified apifields match
categoryid
Category ID or List of Category IDs.
  • categoryid/s - Projects in specified Category/ies
    Example: 1,2,3
  • !categoryid/s - Projects NOT in specified Category/ies
    Example: !1,2,3
completedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
completedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
customfields
Custom Field Value/s (Advanced plan only)
  • customfieldid,string - A Custom Field ID and String separated by a comma (Example: 2,Europe) - Projects where the field matches the specified string
    Example: 2,Europe
  • Multiple Custom Field ID and String pairs separated by two pipe characters
    Example: 2,Europe||3,Industrial||3,Commercial
    NOTE: The same Custom Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
customfieldsmode
default: any
Mode used for the customfields parameter.
  • any - Projects where ANY of the specified customfields match
  • all - Projects where ALL of the specified customfields match
customstatusid
Custom Status ID or List of Custom Status IDs (Advanced plan only).
  • customstatusid/s - Projects with specified Custom Status/es
    Example: 1,2
  • !customstatusid/s - Projects without specified Custom Status/es
    Example: !1,2
duedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
groupid
Group (Advanced plan only).
  • groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s
    Example: 1,2
  • !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s
    Example: !1,2
idfrom
Projects with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Projects with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiced
default: all
Invoiced Status.
  • invoiced - Projects marked as Invoiced
  • uninvoiced - Projects marked as Uninvoiced
  • all - All Projects
invoicetotal
Projects where Invoice Total matches criteria.
  • number - Invoice Total is EXACTLY the specified value
    Example: 300
  • gtenumber - Invoice Total is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Invoice Total is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Invoice Total is GREATER THAN Quote Total (Projects with 0 Quote Total ignored)
  • under - Invoice Total is LESS THAN OR EQUAL TO Quote Total (Projects with 0 Quote Total ignored)
  • gtenumber% - Invoice Total is GREATER THAN OR EQUAL to specified percentage of Quote Total (Projects with 0 Quote Total ignored)
    Example: gte30%
  • ltenumber% - Invoice Total is LESS THAN OR EQUAL to specified percentage of Quote Total (Projects with 0 Quote Total ignored)
    Example: lte30%
lastmodifiedfrom
Projects added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Projects added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
managerid
default: all
Manager.
  • managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s
    Example: 1,2
  • !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s
    Example: !1,2
  • me - Projects Managed by Contact making request
  • all - All Projects
paid
default: all
Paid Status.
  • paid - Projects marked as Paid
  • unpaid - Projects marked as Unpaid
  • all - All Projects
priority
Priority or List of Priorities (1-5 representing Very High-Very Low).
  • priority/ies - Projects with specified Priority/ies
    Example: 1,2
  • !priority/ies - Projects NOT with specified Priority/ies
    Example: !4,5
quotetotal
Projects where Quote Total matches criteria.
  • number - Quote Total is EXACTLY the specified value
    Example: 300
  • gtenumber - Quote Total is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Quote Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
search
Search.
  • string - Projects where Number or Title contains string
    Example: website
  • !string - Projects where Number and Title do not contain string
    Example: !layout
searchcustomform
Search Custom Form (Advanced plan only).
  • string - Projects where Custom Form contains string
    Example: website
  • !string - Projects where Custom Form does not contain string
    Example: !layout
searchdescription
Search Description.
  • string - Projects where Description contains string
    Example: website
  • !string - Projects where Description does not contain string
    Example: !layout
searchnumber
Search Name.
  • string - Projects where Number contains string
    Example: website
  • !string - Projects where Number does not contain string
    Example: !layout
searchtitle
Search Title.
  • string - Projects where Title contains string
    Example: website
  • !string - Projects where Title does not contain string
    Example: !layout
startdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
startdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
status
default: active
Status.
  • active - Active Projects
  • complete - Completed Projects
  • all - All Projects
teamid
Team (Advanced plan only).
  • teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s
    Example: 1,2
  • !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s
    Example: !1,2
timeallocated
Time Allocated.
  • number - Time Allocated (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber - Time Allocated (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Time Allocated (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
timebillable
default: all
Billable/Non-billable/All Time Tracked.
  • all - All Time
  • billable - Billable Time only
  • nonbillable - Non-billable Time only
timetracked
Projects where Time Tracked matches criteria.
timetrackedby, timetrackedfrom, timetrackedto and timebillable parameters will apply to the starred options.
IMPORTANT: The non-starred options will always use the Total Time Tracked (all contacts, dates, billable status) for comparison.
  • number* - Time Tracked (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber* - Time Tracked (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber* - Time Tracked (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Total Time Tracked is GREATER THAN Allocated Time
  • under - Total Time Tracked is LESS THAN OR EQUAL TO Allocated Time
  • gtenumber% - TOTAL Time Tracked is GREATER THAN OR EQUAL to specified percentage of Allocated Time
    Example: gte30%
  • ltenumber% - TOTAL Time Tracked is LESS THAN OR EQUAL to specified percentage of Allocated Time
    Example: lte30%
timetrackedby
default: all
Time Tracked By.
  • contactid/s - Contact ID or List of Contact IDs - Time Tracked by specified Contact/s
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Time NOT Tracked by specified Contact/s
    Example: !1,2
  • me - Time Tracked by Contact making request
  • all - All Time Tracked
timetrackedfrom
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
timetrackedto
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Projects.
Example: pagenumber=2&pagesize=10 (return Projects 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: number
Sort field.
  • id - ID
  • title - Title
  • number - Number
  • startdate - Start Date
  • duedate - Due Date
  • completedate - Complete Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Project

This call adds a Project for a Contact. In the Advanced Plan you may specify templateid to use a Project Template (any values you provide will override those in the Project Template). In the Advanced Plan you must specify groupid if the managerid belongs to more than 1 group.
Show Sample POST data

{
   "title":"Sample Project",
   "number":"auto",
   "description":"Sample Project Description",
   "managerid":"me",
   "staff":"2,3,5",
   "clients":"6,7",
   "contractors":"9,10",
   "priority":2,
   "startdate":"2014-04-18",
   "duedate":"2014-04-28",
   "customfields":
   [
      {
         "id":1,
         "value":"Europe"
      },
      {
         "id":2,
         "value":"Industrial"
      }
   ]
}

REQUIRED PARAMETERS:

title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
autonumberid
Autonumbering Option ID (Advanced Plan only, required if Advanced autonumbering is enabled and the Team of 'managerid' has more than one Autonumber option. The 'settings/projects/autonumbering' call returns a list of available IDs.).
  • autonumberid - Autonumbering Option ID
    Example: 1
categoryid
Project Category ID.
  • categoryid - Category ID
    Example: 1
clientaccess
Client Access (true/false to set whether Client can View this Project).
  • true - Client can View Project
  • false - Client cannot View Project
clients
Assigned Clients.
  • clients - Contact ID or List of Contact IDs
    Example: 1,2,3
completedate
Complete Date, if specified then the Project will be added with a Completed status (alerts are not sent when adding Completed Projects).
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
contractors
Assigned Contractors.
  • contractors - Contact ID or List of Contact IDs
    Example: 1,2,3
customfields
Custom Field Value/s (Advanced plan only)
  • customfields - Custom Fields
    You must specify id and value (use the settings/projects/customfields call for a list of ids and values).
    Example:
    "customfields":
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
customformcontent
Custom Form Content (Advanced plan only).
  • customformcontent - Custom Form Content
    Example: Sample Form Content
customformtitle
Custom Form Title (Advanced plan only).
  • customformtitle - Custom Form Title
    Example: Sample Form Title
customstatusid
Custom Status ID (Advanced plan only).
  • customstatusid - Custom Status ID
    Example: 1
description
Description.
  • description - Description
    Example: Sample Description
duedate
Due Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
emailalerts
Email Alerts (true/false to set whether Email Alerts are sent for activity in this Project).
  • true - Send Email Alerts
  • false - Don't Send Email Alerts
groupid
Group ID (Advanced Plan only, required if managerid belongs to more than 1 Group).
  • groupid - Group ID
    Example: 1
invoicetotal
Invoiced Value.
  • invoicetotal - Invoiced Value
    Example: 1000.00
  • auto - Total of Project Invoices
managerid
default: me
Manager ID.
  • managerid - Manager Contact ID
    Example: 1
  • me - Contact making request
number
default: auto
Number.
  • number - Number
    Example: ABC-00001
  • auto - Use Autonumbering
priority
Priority (1-5 representing Very High-Very Low).
  • priority - Priority
    Example: 1
privatenotes
Private Notes (Visible to Staff only).
  • privatenotes - Private Notes
    Example: Sample Private Notes
quotetotal
Quoted Value.
  • quotetotal - Quoted Value
    Example: 1000.00
  • auto - Total of Project Quotes
staff
Assigned Staff.
  • staff - Contact ID or List of Contact IDs
    Example: 1,2,3
  • me - Contact making request
startdate
Start Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
templateid
Template ID (Advanced plan only).
  • templateid - Project Template ID
    Example: 1
timeallocated
Time Allocated.
  • number - Time Allocated (minutes)
    Example: 300

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Roles for a Staff Contact

This call returns a list of roles for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Add/Remove Roles for a Staff Contact

This call adds or removes roles for a Contact.

REQUIRED PARAMETERS:

roleid
Roles to Add/Remove.
  • roles - Role ID or List of Role IDs
    Example: 1,2,3

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

remove
default: false
Set as 'true' to remove Roles (default is to add them).
  • true - Remove Roles from Contact
  • false - Add Roles to Contact

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Contact Summary

This call returns a list of Contacts, Invoices, Projects, Quotes and Tasks for the specified Contact. Limited data is returned for each item and this call is not intended to replace the individual calls which offer much more extensive options.

Instead, this call is designed to be used when you need to fetch a summary of current activity for a Contact.

By default this will return the first 10 results for each of the following (assuming the user has the relevant permission):

Projects: Number, Title, Company and ID (Active Projects)
Tasks: Name, Order, Project and ID (Active Tasks)

REQUIRED PARAMETERS:

FIELD PARAMETERS:

types
default: all
Data Types to return.
  • all - Return all data types
  • Comma separated list of any of the following:
    • projects
    • tasks
    Example: contacts,projects

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

pagenumber
default: 1
Page Number (must be used with pagesize) to return a subset of each Data Type.
Example: pagenumber=2&pagesize=10 (return rows 11-20).
  • pagenumber
pagesize
default: 10
Page Size (must be used with pagenumber).
  • pagesize
Staff
Client
Contractor
View Tags for a Contact

This call returns a list of tags for a Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Add/Remove Tags for a Contact

This call adds or removes tags for a Contact.

REQUIRED PARAMETERS:

tagid
Tags to Add/Remove.
  • tags - Tag ID or List of Tag IDs
    Example: 1,2,3

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

remove
default: false
Set as 'true' to remove Tags (default is to add them).
  • true - Remove Tags from Contact
  • false - Add Tags to Contact

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Tasks for a Contact

This call returns a list of Tasks for a Contact based on the specified filters. The fields parameter allows you to choose which data fields to return for each Task.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,type,order,status,project,startdate,duedate
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • billable
    • category
    • company
    • completedate
    • contacts
    • creator
    • (contact who added this Task)
    • dates (returns start/due/complete)
    • dependent (returns dependent/current status)
    • description
    • duedate
    • lastmodified
    • name
    • order
    • priority
    • project
    • (returns ID/Number/Title)
    • projectcategory
    • (returns ID/Name)
    • projectmanager
    • (returns ID/Name)
    • startdate
    • status
    • timeallocated
    • timetracked
    • type
    Example: order,name,project

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Tasks where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Tasks where ANY of the specified apifields match
  • all - Tasks where ALL of the specified apifields match
billable
default: all
Billable status.
  • true - Billable Tasks
  • false - Non-Billable Tasks
  • all - All Tasks
categoryid
Category.
  • categoryid/s - General Tasks in specified Category/ies
    Example: 1,2
  • !categoryid/s - General Tasks NOT in specified Category/ies
    Example: !1,2
companyid
Company.
  • companyid/s - Company ID or List of Company IDs - Tasks in Projects for specified Company/ies
    Example: 1,2
completedatefrom
Tasks completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
completedateto
Tasks completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dependentstatus
Task Dependent Status - Using this filter will only return Dependent Tasks that meet the specified status.
  • current - Current Dependent Tasks
  • noncurrent - Non-Current Dependent Tasks
  • all - All Dependent Tasks
divisionid
Division ID (Advanced plan only).
  • divisionid - Tasks in specified Division
    Example: 1
duedatefrom
Tasks due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Tasks due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
generaltasks
default: true
General Tasks.
  • true - Include General Tasks
  • false - Exclude General Tasks
idfrom
Tasks with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Tasks with ID greater than or equal to this value .
  • id - ID
    Example: 1
internalclientgroupid
Group ID or List of Group IDs.
  • groupid/s - Tasks for specified Group/s
    Example: 1,2,3
internalclientteamid
Team ID or List of Team IDs.
  • companyid/s - Tasks for specified Team/s
    Example: 1,2,3
lastmodifiedfrom
Tasks added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Tasks added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
managerid
Manager.
  • managerid/s - Contact ID or List of Contact IDs - Tasks in Projects managed by specified Contact/s
    Example: 1,2
  • me - Tasks in Projects managed by Contact making request
priority
Priority (1-5 representing Very High-Very Low).
  • priority/ies - Tasks with specified Priority/ies
    Example: 1,2
  • !priority/ies - Tasks NOT with specified Priority/ies
    Example: !4,5
projectcategoryid
Project Category ID or List of Project Category IDs.
  • projectcategoryid/s - Tasks in Projects in specified Category/ies
    Example: 1,2,3
projectcompletedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectcompletedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectid
Project.
  • projectid/s - Tasks in specified Project/s
    Example: 1,2
projectstartdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstartdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstatus
default: all
Project Status.
  • active - Tasks in Active Projects
  • complete - Tasks in Completed Projects
  • all - Tasks in All Projects
projecttasks
default: true
Project Tasks.
  • true - Include Project Tasks
  • false - Exclude Project Tasks
searchdescription
Search Description.
  • string - Tasks where Description contains string
    Example: website
  • !string - Tasks where Description does not contain string
    Example: !layout
searchname
Search Name.
  • string - Tasks where Name contains string
    Example: website
  • !string - Tasks where Name does not contain string
    Example: !layout
startdatefrom
Tasks starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
startdateto
Tasks starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
status
default: active
Task Status.
  • active - Active Tasks
  • complete - Completed Tasks
  • all - All Tasks
timeallocated
Time Allocated.
  • number - Time Allocated (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber - Time Allocated (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber - Time Allocated (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
timetracked
Tasks where Time Tracked matches criteria.
timetrackedby, timetrackedfrom, timetrackedto parameters apply to the starred options.
  • number* - Time Tracked (minutes) is EXACTLY the specified value
    Example: 300
  • gtenumber* - Time Tracked (minutes) is GREATER THAN OR EQUAL to specified value
    Example: gte300
  • ltenumber* - Time Tracked (minutes) is LESS THAN OR EQUAL to specified value
    Example: lte300
  • over - Total Time Tracked is GREATER THAN Allocated Time
  • under - Total Time Tracked is LESS THAN OR EQUAL TO Allocated Time
  • gtenumber% - TOTAL Time Tracked is GREATER THAN OR EQUAL to specified percentage of Allocated Time
    Example: gte30%
  • ltenumber% - TOTAL Time Tracked is LESS THAN OR EQUAL to specified percentage of Allocated Time
    Example: lte30%
timetrackedby
default: all
Time Tracked By.
  • contactid/s - Contact ID or List of Contact IDs - Time Tracked by specified Contact/s
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Time NOT Tracked by specified Contact/s
    Example: !1,2
  • me - Time Tracked by Contact making request
  • all - All Time Tracked
timetrackedfrom
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
timetrackedto
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
type
default: all
Task Type.
  • normal - Normal Tasks
  • bold - Bold Tasks
  • heading - Heading Tasks
  • nonheading - Non-Heading Tasks (Normal + Bold)
  • all - All Tasks

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Tasks.
Example: pagenumber=2&pagesize=10 (return Tasks 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: id
Sort field.
  • id - ID
  • order - Order
  • name - Name
  • startdate - Start Date
  • duedate - Due Date
  • completedate - Complete Date
  • projectid - Project ID
  • projectnumber - Project Number
  • projecttitle - Project Title
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Time Tracked by a Contact

This call returns a the Total time tracked by a Contact based on the filters specified. The subtotals parameter allows you to return Sub Totals of time tracked. The fields parameter allows you to return individual Time Records and choose which data fields to return for each Time Record.

REQUIRED PARAMETERS:

trackedfrom
default: -6d
Time tracked on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
trackedto
default: +0d
Time Tracked on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

FIELD PARAMETERS:

fields
Fields to return - if not specified then only Total/Sub Totals will be returned.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • billable
    • category (Project Category)
    • company
    • contact
    • dates
    • lastmodified
    • notes
    • project
    • task
    • tasktimetotals (Total allocated/tracked time for the task)
    • timetracked
    Example: contact,task,timetracked
  • none - return only Total/Subtotals
subtotals
Sub Totals to return - if not specified then only Fields and/or Total will be returned.
  • Comma separated list of any of the following in the required order:
    • billable
    • category
    • company
    • contact
    • group (Advanced plan only, Group in charge of Project)
    • internalclientgroup (Advanced plan only, Group of Internal Client for Project)
    • internalclientteam (Advanced plan only, Team of Internal Client for Project)
    • project
    • task
    • team (Advanced plan only, Team in charge of Project)

    • day
    • week
    • month
    • year
    • If week is used then the 'trackedfrom' date will be used as the first day of the week.
      Example: contact,company - return Sub Totals of Time Tracked for each combination of Contact and Company.
      NOTE - Only non-zero Sub Totals will be returned.

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma (Example: 2,Europe) - Time Records where the field contains the specified string
  • Multiple API Field ID and String pairs separated by two pipe characters
    Example: 2,Europe||3,Industrial||3,Commercial
    The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Time Records where ANY of the specified apifields match
  • all - Time Records where ALL of the specified apifields match
billable
default: all
Billable status.
  • billable - Billable Time
  • nonbillable - Non-Billable Time
  • all - All Time
categoryid
Project Category ID or List of Project Category IDs.
  • categoryid/s - Time for Projects in specified Category/ies
    Example: 1,2
companyid
Company ID or List of Company IDs.
  • companyid/s - Time in specified Company/ies
    Example: 1,2,3
generaltasks
default: true
General Tasks.
  • true - Include Time for General Tasks
  • false - Exclude Time for General Tasks
idfrom
Time Records with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Time Records with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Time Records added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Time Records added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
projectcompletedatefrom
Projects completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectcompletedateto
Projects completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedatefrom
Projects due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectduedateto
Projects due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectid
Project ID or List of Project IDs.
  • projectid/s - Time for specified Project/s
    Example: 1,2
projectstartdatefrom
Projects starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectstartdateto
Projects starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projecttasks
default: true
Project Tasks.
  • true - Include Time for Project Tasks
  • false - Exclude Time for Project Tasks
taskcompletedatefrom
Tasks completed on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskcompletedateto
Tasks completed on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskduedatefrom
Tasks due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskduedateto
Tasks due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskid
Task ID or List of Task IDs.
  • taskid/s - Time for specified Task/s
    Example: 1,2
taskstartdatefrom
Tasks starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
taskstartdateto
Tasks starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

sortby
default: id
Sort field for Time Records.
  • id - Time Record ID
  • date - Time Record Date
  • taskid - Task ID
  • projectid - Project ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Client Contacts

This call returns a list of Client Contacts based on the specified filters. The fields parameter allows you to choose which data fields to return for each Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,company,type
Fields to return, only Staff contacts view * fields.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • address
    • company
    • email*
    • groups* (Advanced plan only)
    • image
    • lastmodified
    • location* (returns latitude, longitude and locationtime - the time the location was last updated)
    • logindetails* (returns allowlogin and username)
    • name
    • phone*
    • tags*
    • teams* (Advanced plan only)
    • title*
    • type
    Example: name,email,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

allowlogin
Login status.
  • true - Contacts with Login Access
  • false - Contacts without Login Access
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Contacts where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Contacts where ANY of the specified apifields match
  • all - Contacts where ALL of the specified apifields match
companyid
Company ID.
  • companyid - Contacts in specified Company
    Example: 1
divisionid
Division ID (Advanced plan only).
  • divisionid - Contacts in specified Division
    Example: 1
idfrom
Contacts with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Contacts with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Contacts added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Contacts added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Contacts
  • false - Active Contacts
search
Search string.
  • string - Contacts where Name or Email contains string
    Example: website
  • !string - Contacts where Name and Email do not contain string
    Example: !layout
searchemail
Search string.
  • string - Contacts where Email Address contains string
    Example: website
  • !string - Contacts where Email Address does not contain string
    Example: !layout
searchname
Search string.
  • string - Contacts where Name contains string
    Example: website
  • !string - Contacts where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Contacts with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Contacts.
Example: pagenumber=2&pagesize=10 (return Contacts 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: firstname
Sort field.
  • id - Contact ID
  • firstname - Contact First Name
  • lastname - Contact Last Name
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
View Contractor Contacts

This call returns a list of Contractor Contacts based on the specified filters. The fields parameter allows you to choose which data fields to return for each Contact.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,company,type
Fields to return, only Staff contacts view * fields.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • address
    • company
    • email*
    • groups* (Advanced plan only)
    • image
    • lastmodified
    • location* (returns latitude, longitude and locationtime - the time the location was last updated)
    • logindetails* (returns allowlogin and username)
    • name
    • phone*
    • tags*
    • teams* (Advanced plan only)
    • title*
    • type
    Example: name,email,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

allowlogin
Login status.
  • true - Contacts with Login Access
  • false - Contacts without Login Access
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Contacts where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Contacts where ANY of the specified apifields match
  • all - Contacts where ALL of the specified apifields match
companyid
Company ID.
  • companyid - Contacts in specified Company
    Example: 1
divisionid
Division ID (Advanced plan only).
  • divisionid - Contacts in specified Division
    Example: 1
idfrom
Contacts with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Contacts with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Contacts added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Contacts added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Contacts
  • false - Active Contacts
search
Search string.
  • string - Contacts where Name or Email contains string
    Example: website
  • !string - Contacts where Name and Email do not contain string
    Example: !layout
searchemail
Search string.
  • string - Contacts where Email Address contains string
    Example: website
  • !string - Contacts where Email Address does not contain string
    Example: !layout
searchname
Search string.
  • string - Contacts where Name contains string
    Example: website
  • !string - Contacts where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Contacts with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Contacts.
Example: pagenumber=2&pagesize=10 (return Contacts 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: firstname
Sort field.
  • id - Contact ID
  • firstname - Contact First Name
  • lastname - Contact Last Name
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Request Password Reset

This call sends an email to supplied address with details on how to reset their password.
If no matching address is found, this will return a 404 response code

REQUIRED PARAMETERS:

email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Contacts' Locations

This call returns latitude, longitude and locationtime (when the location was last updated) of all Contacts.
IMPORTANT: Location is not the same as a Contact's Address. Location is used when you need to track a Contact. Contacts who have never updated their location will not be returned.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

divisionid
Division ID (Advanced plan only).
  • divisionid - Contacts in specified Division
    Example: 1
locationtimefrom
Contacts who updated their location on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
locationtimeto
Contacts who updated their location on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Request Access to ProWorkflow.

This call adds one or more Contacts.
IMPORTANT: Advanced Plan Only - Contact/Company will be added to Division ID 1.
Show Sample POST data

{
   "firstname":"Adam",
   "lastname":"West",
   "email":"noreply@proworkflow.com",
   "type":"client",
   "companyname":"ABC"
}

REQUIRED PARAMETERS:

companyname
Company Name (required unless 'type' is 'staff').
  • companyname - Company Name
    Example: ABC
email
Email Address.
  • email - Email Address
    Example: noreply@proworkflow.com
firstname
First Name.
  • firstname - First Name
    Example: Adam
lastname
Last Name.
  • lastname - Last Name
    Example: West
type
default: client
Contact Type.
  • staff - Staff Contact
  • client - Client Contact
  • contractor - Contractor Contact

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Staff Contacts

This call returns a list of Staff Contacts based on the specified filters. The fields parameter allows you to choose which data fields to return for each Contact. Clients & Contractors can only view limited details about Staff.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,company,type
Fields to return, only Staff contacts view * fields.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • address
    • company
    • email*
    • groups* (Advanced plan only)
    • image
    • lastmodified
    • location* (returns latitude, longitude and locationtime - the time the location was last updated)
    • logindetails* (returns allowlogin and username)
    • name
    • phone*
    • tags*
    • teams* (Advanced plan only)
    • title*
    • type
    Example: name,email,phone

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

allowlogin
Login status.
  • true - Contacts with Login Access
  • false - Contacts without Login Access
apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Contacts where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Contacts where ANY of the specified apifields match
  • all - Contacts where ALL of the specified apifields match
companyid
Company ID.
  • companyid - Contacts in specified Company
    Example: 1
divisionid
Division ID (Advanced plan only).
  • divisionid - Contacts in specified Division
    Example: 1
idfrom
Contacts with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Contacts with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Contacts added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Contacts added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
pending
default: false
Pending status.
  • true - Pending Contacts
  • false - Active Contacts
roleid
Role ID or List of Role IDs.
  • roleid/s - Contacts with at least one of the specified Role ID/s
    Example: 1,2,3
search
Search string.
  • string - Contacts where Name or Email contains string
    Example: website
  • !string - Contacts where Name and Email do not contain string
    Example: !layout
searchemail
Search string.
  • string - Contacts where Email Address contains string
    Example: website
  • !string - Contacts where Email Address does not contain string
    Example: !layout
searchname
Search string.
  • string - Contacts where Name contains string
    Example: website
  • !string - Contacts where Name does not contain string
    Example: !layout
tagid
Tag ID or List of Tag IDs.
  • tagid/s - Contacts with at least one of the specified Tag ID/s
    Example: 1,2,3

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Contacts.
Example: pagenumber=2&pagesize=10 (return Contacts 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: firstname
Sort field.
  • id - Contact ID
  • firstname - Contact First Name
  • lastname - Contact Last Name
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending

DELETE PUT POST GET

Staff
Client
Contractor
View Events

This call returns a list of Events based on the filters specified. The fields parameter allows you to choose which data fields to return for each Event.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,description,times,contacts
Fields to return.
  • Comma separated list of any of the following:
    • contacts
    • description
    • endtime
    • lastmodified
    • starttime
    • times (start and end time)
    • title
    Example: title,description,times

OPTIONAL PARAMETERS:

contactdetails
default: false
Contact Details.
  • true - Return email, image, phone for contacts
  • false - Do not return email, image, phone for contacts

FILTER PARAMETERS:

contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Events assigned to ANY/ALL specified Contact/s (see contactsmode parameter)
    Example: 1,2
  • me - Events assigned to Contact making request
  • all - All Events
contactsmode
default: any
Mode used for the contacts parameter.
  • any - Events assigned to ANY of the specified contacts
  • all - Events assigned to ALL of the specified contacts
divisionid
Division ID (Advanced plan only).
  • divisionid - Events in specified Division
    Example: 1
endtimefrom
Events ending on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
endtimeto
Events ending on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
id
List of Event IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Events with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Events with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Events added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Events added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
searchdescription
Search Description.
  • string - Events where Description contains string
    Example: website
  • !string - Events where Description does not contain string
    Example: !layout
searchtitle
Search Title.
  • string - Events where Title contains string
    Example: website
  • !string - Events where Title does not contain string
    Example: !layout
starttimefrom
Events starting on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
starttimeto
Events starting on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Events.
Example: pagenumber=2&pagesize=10 (return Events 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: id
Sort field for Events.
  • id - Event ID
  • title - Event Title
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add an Event

This call adds a single Event.
Show Sample POST data

{
   "contacts":"1,2",
   "title":"New Event",
   "description":"Event Description",
   "starttime":"2014-03-20T13:00",
   "endtime":"2014-03-20T14:00"
}

REQUIRED PARAMETERS:

contacts
default: me
Assigned Staff Contacts.
  • contactid/s - Contact ID or List of Contact IDs
    Example: 1,2
  • me - Contact making request
  • all - All Staff
endtime
End Time.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • now - Current time
starttime
Start Time.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • now - Current time
title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

description
Description.
  • description - Description
    Example: Sample Description

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View an Event

This call returns details of a single Event.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete an Event

This call deletes a single Event.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit an Event

This call updates a single Event.
Show Sample PUT data

{
   "contacts":"1,2",
   "title":"New Event",
   "description":"Event Description",
   "starttime":"2014-03-20T13:00",
   "endtime":"2014-03-20T14:00"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

contacts
Contacts.
  • contactid/s - Contact ID or List of Contact IDs
    Example: 1,2
  • me - Contact making request
  • all - All Staff
description
Description.
  • description - Description
    Example: Sample Description
endtime
End Time.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • now - Current time
starttime
Start Time.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • now - Current time
title
Title.
  • title - Title
    Example: Sample title

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

DELETE PUT POST GET

Staff
Client
Contractor
View Expenses

This call returns a list of Expenses based on the filters specified. The fields parameter allows you to choose which data fields to return for each Expense.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,description,cost,project,date
Fields to return.
  • Comma separated list of any of the following:
    • company
    • contact
    • cost
    • date
    • description
    • invoiced
    • name
    • project(includes id/number/title)
    • taxable
    Example: name,cost,date

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

categoryid
Project Category ID or List of Project Category IDs.
  • categoryid/s - Expenses for Projects in specified Category/ies
    Example: 1,2
companyid
Company ID or List of Company IDs.
  • companyid/s - Expenses for specified Company/ies
    Example: 1,2,3
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Expenses for specified Contact/s
    Example: 1,2
  • me - Expenses for Contact making request
  • all - Expenses for All Contacts
datefrom
Expenses added on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dateto
Expenses added on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
divisionid
Division ID (Advanced plan only).
  • divisionid - Expenses in specified Division
    Example: 1
id
List of Expense IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Expenses with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Expenses with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiced
default: all
Invoiced status.
  • invoiced - Invoiced Expenses
  • uninvoiced - Uninvoiced Expenses
  • all - All Expenses
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Expenses for specified Project/s
    Example: 1,2
projectstatus
default: active
Project Completion Status.
  • active - Expenses for Active Projects
  • complete - Expenses for Completed Projects
  • all - Expenses for All Projects
search
Search string.
  • string - Expenses where Name contains string
    Example: website
  • !string - Expenses where Name does not contain string
    Example: !layout
taxable
default: all
Taxable status.
  • taxable - Taxable Expenses
  • nontaxable - Non-Taxable Expenses
  • all - All Expenses

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Expenses.
Example: pagenumber=2&pagesize=10 (return Expenses 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: date
Sort field.
  • id - Expense ID
  • name - Expense Name
  • date - Expense Date
  • projectid - Project ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add an Expense

This call adds a single Expense.
Show Sample POST data

{
   "projectid":1,
   "name":"New Expense",
   "description":"Event Description",
   "date":"2014-03-28",
   "cost":100.00
}

REQUIRED PARAMETERS:

cost
Cost of Expense.
  • cost - Cost
    Example: 500.00
name
Name.
  • name - Name
    Example: Sample Name
projectid
Project ID.
  • projectid - Project ID

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

date
Date of Expense.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
description
Description.
  • description - Description
    Example: Sample Description
invoiced
default: false
Invoiced status.
  • true - Invoiced
  • false - Uninvoiced
taxable
default: true
Taxable status.
  • true - Taxable
  • false - Non-Taxable

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View an Expense

This call returns details of a single Expense.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete an Expense

This call deletes a single Expense.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit an Expense

This call updates a single Expense.
Show Sample PUT data

{
   "date":"2014-03-28",
   "cost":100.00
   "invoiced":true
}

REQUIRED PARAMETERS:

cost
Cost of Expense.
  • cost - Cost
    Example: 500.00
name
Name.
  • name - Name
    Example: Sample Name

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

date
Date of Expense.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
description
Description.
  • description - Description
    Example: Sample Description
invoiced
Invoiced status.
  • true - Invoiced
  • false - Uninvoiced
taxable
Taxable status.
  • true - Taxable
  • false - Non-Taxable

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

DELETE PUT POST GET

Staff
Client
Contractor
View Files

This call returns a list of Files based on the filters specified. The fields parameter allows you to choose which data fields to return for each File.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,project,task,date,size,link
Fields to return.
  • Comma separated list of any of the following:
    • contacts (returns 'all' if File is public, returns array of contacts if File is private)
    • date
    • folder (includes id,name)
    • link
    • name
    • project (includes id/number/title)
    • size
    • task (includes id/name)
    Example: name,size,link

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

datefrom
Files added on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dateto
Files added on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
divisionid
Division ID (Advanced plan only).
  • divisionid - Files in specified Division
    Example: 1
folderid
Folder ID or List of Folder IDs.
  • folderid/s - Folder ID or List of Folder IDs - Files in specified Folder/s
    Example: 1,2
id
List of File IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Files with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Files with ID greater than or equal to this value .
  • id - ID
    Example: 1
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Files for specified Project/s
    Example: 1,2
projectstatus
default: active
Project Status.
  • active - Files for Active Projects
  • complete - Files for Completed Projects
  • all - Files for All Projects
search
Search string.
  • string - Files where Name contains string
    Example: website
  • !string - Files where Name does not contain string
    Example: !layout
taskid
Task ID or List of Task IDs.
  • taskid/s - Task ID or List of Task IDs - Files for specified Task/s
    Example: 1,2
taskstatus
default: all
Task Status.
  • active - Files for Active Tasks
  • complete - Files for Completed Tasks
  • all - Files for All Tasks

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Files.
Example: pagenumber=2&pagesize=10 (return Files 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - File ID
  • name - File Name
  • size - File Size
  • date - File Date
  • projectid - Project ID
  • taskid - Task ID
  • folderid - Folder ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a File

This call adds a single File.
Show Sample POST data

{
   "projectid":1,
   "name":"filename.txt",
   "content":"U29tZSB0ZXh0"
}

REQUIRED PARAMETERS:

content
Base64-encoded content.
  • content - Name
    Example: U29tZSB0ZXh0
folderid
Folder ID (Exactly 1 of Project/Task/Folder Required).
  • folderid - Folder ID
    Example: 1
name
Name.
  • name - Name
    Example: Sample Name
projectid
Project or Project Request ID (Exactly 1 of Project/Task/Folder Required).
  • projectid - Project or Project Request ID
    Example: 1
taskid
Task ID (Exactly 1 of Project/Task/Folder Required).
  • taskid - Task ID
    Example: 1

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a File

This call returns details of a single File.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

content
default: false
Return Base64 Encoded Content
Important: Not available for files larger than 1MB
  • true - Return 'content' field
  • false - Do not return 'content' field

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a File

This call returns deletes a single File.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Custom Folders

This call returns a list of Custom Folders based on the filters specified. The fields parameter allows you to choose which data fields to return for each Custom Folder.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: name,project,contacts
Fields to return.
  • Comma separated list of any of the following:
    • contacts (returns 'all' if Folder is public, returns array of contacts if Folder is private)
    • name
    • project (includes id/number/title)
      • Example: name,contacts

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

divisionid
Division ID (Advanced plan only).
  • divisionid - Folders in specified Division
    Example: 1
id
List of Folder IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Folders with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Folders with ID greater than or equal to this value .
  • id - ID
    Example: 1
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Folders for specified Project/s
    Example: 1,2
projectstatus
default: active
Project Status.
  • active - Folders for Active Projects
  • complete - Folders for Completed Projects
  • all - Folders for All Projects
search
Search string.
  • string - Folders where Name contains string
    Example: website
  • !string - Folders where Name does not contain string
    Example: !layout

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Folders.
Example: pagenumber=2&pagesize=10 (return Folders 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: name
Sort field.
  • id - Folder ID
  • name - Folder Name
  • projectid - Project ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Custom Folder

This call adds a single Custom Folder.
Show Sample POST data

{
   "projectid":1,
   "name":"New Folder",
   "contacts":"1,2,3"
}

REQUIRED PARAMETERS:

contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Add Private Folder for specified Contact/s
    Example: 1,2,3
  • me - Add Private Folder for Contact making request
  • all - Add Public Folder
name
Name.
  • name - Name
    Example: Sample Name
projectid
Project ID.
  • projectid - Project ID
    Example: 1

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Custom Folder

This call returns details of a single Custom Folder.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

DELETE PUT POST GET

Staff
Client
Contractor
View Invoices/Totals

This call returns a list of Invoices based on the filters specified and optionally subtotals based on the grouping options specified, it also returns the totals of all the returned quotes. The subtotals parameter allows you to return Sub Totals of invoiced amounts. The fields parameter allows you to return individual Invoices and choose which data fields to return for each Invoice. This call does not return details of the individual lines for each Invoice, you can use the specific Invoice call to return that information.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: number,title,company,status,totals,projectid,invoiceddate,duedate
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • company
    • customfield (returns customfieldname and customfieldvalue)
    • dates (invoiced/due/paid)
    • description
    • duedate
    • emaileddate
    • emailedto
    • invoicedby
    • invoiceddate
    • lastmodified
    • number
    • paiddate
    • project (project id/title/number)
    • purchaseordernumber
    • showcostbreakdown
    • status
    • taxable
    • taxrate
    • title
    • totals (sub/tax/grand totals)
    Example: number,title,totals
  • none - return only Totals/Subtotals
subtotals
Sub Totals - specify required subtotals, if not specified then only Fields/Totals will be returned.
  • Comma separated list of any of the following in the required order:
    • company
    • project
    • status

    • day
    • week
    • month
    • year
    Use the 'subtotalsdateoption' to specify whether to group by invoiced, due or paid date (if week is used then the 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' date will be used as the first day of the week).
    Example: company,month - return Sub Totals of Invoiced amounts for each combination of Company and Month.
    NOTE - Only non-zero Sub Totals will be returned.
    IMPORTANT - To use date grouping options you must specify 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' depending on the option user for 'subtotalsdateoption'.

OPTIONAL PARAMETERS:

subtotalsdateoption
default: invoiced
Sub Totals Date Option - specify the date to group by when using a date option in the 'subtotals' option.
  • invoiced - Group by Invoiced Date
  • due - Group by Due Date
  • paid - Group by Paid Date

FILTER PARAMETERS:

apifields
API Field Value/s
  • apifieldid,string - An API Field ID and String separated by a comma - Invoices where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Invoices where ANY of the specified apifields match
  • all - Invoices where ALL of the specified apifields match
companyid
Company ID or List of Company IDs.
  • companyid/s - Invoices in specified Company/ies
    Example: 1,2,3
divisionid
Division ID (Advanced plan only).
  • divisionid - Invoices in specified Division
    Example: 1
duedatefrom
Invoices due on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Invoices due on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
grandtotal
Invoice grandtotal.
  • number - Invoice Invoice Grand Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Grand Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Grand Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
id
List of Invoice IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Invoices with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Invoices with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiceddatefrom
Invoices created on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
invoiceddateto
Invoices created on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
lastmodifiedfrom
Invoices added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Invoices added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
managerid
Manager.
  • managerid/s - Contact ID or List of Contact IDs - Invoices in Projects managed by specified Contact/s
    Example: 1,2
  • me - Invoices in Projects managed by Contact making request
paiddatefrom
Invoices paid on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
paiddateto
Invoices paid on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectcategoryid
Project Category ID or List of Project Category IDs.
  • projectcategoryid/s - Invoices in Projects in specified Category/ies
    Example: 1,2,3
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Invoices for specified Project/s
    Example: 1,2
projectstatus
default: all
Project Status.
  • active - Invoices in Active Projects
  • complete - Invoices in Completed Projects
  • all - Invoices in All Projects
search
Search string.
  • string - Invoices where Number or Title contains string
    Example: website
  • !string - Invoices where Number and Title do not contain string
    Example: !layout
searchnumber
Search string.
  • string - Invoices where Number contains string
    Example: website
  • !string - Invoices where Number does not contain string
    Example: !layout
searchtitle
Search string.
  • string - Invoices where Title contains string
    Example: website
  • !string - Invoices where Title does not contain string
    Example: !layout
status
default: unpaid
Invoice Status.
  • paid - Paid Invoices
  • unpaid - Unpaid Invoices
  • all - All Invoices
subtotal
Invoice Sub Total.
  • number - Invoice Sub Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Sub Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Sub Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
taxable
default: all
Taxable status.
  • true - Taxable Invoices
  • false - Non-Taxable Invoices
  • all - All Invoices
taxtotal
Invoice Tax Total.
  • number - Invoice Invoice Tax Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Tax Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Tax Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Invoices.
Example: pagenumber=2&pagesize=10 (return Invoices 11-20). (Paging options are not available if you are using the 'subtotals' option)
  • pagenumber
pagesize
Page Size (must be used with pagenumber). (Paging options are not available if you are using the 'subtotals' option)
  • pagesize
sortby
default: number
Sort field.
  • companyname - Company Name
  • duedate - Due Date
  • id - Invoice ID
  • invoiceddate - Invoiced Date
  • number - Invoice Number
  • title - Invoice Title
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add an Invoice

This call adds a simple Invoice..
Show Sample POST data

{
   "title":"New Invoice",
   "number":"auto",
   "description":"Invoice Description",
   "contactid":1,
   "projectid":2,
   "lines":
   [
      {
         "type":"heading",
         "name":"Redesign Work"
      },
      {
         "type":"lineitem",
         "name":"Line Item 1",
         "quantity":1,
         "rate":100.00,
         "taxable":true
      },
      {
         "type":"taskrate",
         "name":"Task Rate",
         "time":60,
         "rate":100.00,
         "taxable":false
      },
      {
         "type":"staffrate",
         "name":"Alex Trip",
         "time":60,
         "rate":100.00,
         "taxable":false
      }
   ]
}

REQUIRED PARAMETERS:

companyid
Client Company ID.
  • companyid - Company ID
    Example: 1
contactid
Client Contact ID.
  • contactid - Contact ID
    Example: 1
lines
Line/s.
  • lines - Line/s

    The 'type' must be specified, the following must then be specified depending on the 'type':
    • 'heading' - Must provide 'name'
    • 'expense' - Must provide 'name' as well as 'quantity' & 'rate'
    • 'lineitem' - Must provide 'name' or 'description' as well as 'quantity' & 'rate'
    • 'staffrate' - Must provide 'name', 'time' & 'rate'
    • 'taskrate' - Must provide 'name', 'time' & 'rate'
    Example:
    [
       {
          "type":"heading",
          "name":"Redesign Work"
       },
       {
          "type":"lineitem",
          "name":"Line Item 1",
          "name":"Line Item 1 Description",
          "quantity":1,
          "rate":100.00,
          "taxable":true
       },
       {
          "type":"taskrate",
          "name":"Task Rate",
          "time":60,
          "rate":100.00,
          "taxable":false
       },
       {
          "type":"staffrate",
          "name":"Alex Trip",
          "time":60,
          "rate":100.00,
          "taxable":false
       }
    ]
projectid
Project ID.
  • projectid - Attach Invoice to Project ID
    Example: 1
title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
companyname
Address Company Name.
  • companyname - Address Line 2
    Example: ABC Ltd
contactname
Address Contact Name.
  • contactname - Address Line 1
    Example: Amy Adams
country
Country.
  • country - Country
    Example: Someland
description
Description.
  • description - Description
    Example: Sample Description
discountdescription
default: Discount
Discount Description.
  • discountdescription - Discount Description
    Example: Sample Discount
discountvalue
Discount Value.
  • number - Apply a Fixed Value Discount
    Example: 500
  • number% - Apply a percentage Discount
    Example: 10%
duedate
Due Date (if not specified then this will be calculated automatically from Invoiced Date and default payment settings).
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
invoiceddate
Invoiced Date (defaults to current date)
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
markprojectasinvoiced
default: false
Mark Project as Invoiced.
  • true - Project will be set as invoiced
  • false - Project will not be updated
number
default: auto
Number.
  • number - Number
    Example: ABC-00001
  • auto - Use Autonumbering
showcostbreakdown
default: true
Show Cost Breakdown (in main application).
  • true - Show Cost Breakdown
  • false - Hide Cost Breakdown
state
State.
  • state - State
    Example: Somewhere
taxable
default: true
Taxable status.
  • true - Taxable
  • false - Non-Taxable
taxrate
Tax rate (overrides default rate).
  • number - Tax Rate (%)
    Example: 12.5
terms
Terms.
  • terms - Terms
    Example: Valid for 14 Days
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View an Invoice

This call returns details of a single Invoice.
IMPORTANT: For Task/Staff Rate Lines, the 'rate' value is cost/hour, the 'time' value is the time in minutes.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete an Invoice

This call deletes a single Invoice.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit an Invoice

This call updates details of a single Invoice.
IMPORTANT: If you specify any 'lines' then all existing lines will be replaced, if you want to add/edit/remove individual lines then use the dedicated 'invoice/lines' or 'invoice/line' calls instead.
Show Sample PUT data

{
   "status":"paid",
   "discountvalue":100,
   "discountdescription":"Discount Description",
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1.
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2.
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3.
  • address3 - Address Line 3
    Example: Pretend Town
apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
       {
          "id":1, "value":"Europe"
       },
       {
          "id":2, "value":"Industrial"
       }
    ]
city
City.
  • city - City
    Example: Somecity
companyname
Address Company Name.
  • companyname - Address Line 2
    Example: ABC Ltd
contactname
Address Contact Name.
  • contactname - Address Line 1
    Example: Amy Adams
country
Country.
  • country - Country
    Example: Someland
description
Description.
  • description - Description
    Example: Sample Description
discountdescription
Discount Description.
  • discountdescription - Discount Description
    Example: Sample Discount
discountvalue
Discount Value.
  • number - Apply a Fixed Value Discount
    Example: 500
  • number% - Apply a percentage Discount
    Example: 10%
duedate
Due Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
invoiceddate
Invoiced Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
lines
Line/s.
  • lines - Line/s

    The 'type' must be specified, the following must then be specified depending on the 'type':
    • 'heading' - Must provide 'name'
    • 'lineitem' - Must provide 'name' or 'description' as well as 'quantity' & 'rate'
    • 'staffrate' - Must provide 'name', 'time' & 'rate'
    • 'taskrate' - Must provide 'name', 'time' & 'rate'
    Example:
    [
       {
          "type":"heading",
          "name":"Redesign Work"
       },
       {
          "type":"lineitem",
          "name":"Line Item 1",
          "name":"Line Item 1 Description",
          "quantity":1,
          "rate":100.00,
          "taxable":true
       },
       {
          "type":"taskrate",
          "name":"Task Rate",
          "time":60,
          "rate":100.00,
          "taxable":false
       },
       {
          "type":"staffrate",
          "name":"Alex Trip",
          "time":60,
          "rate":100.00,
          "taxable":false
       }
    ]
number
Number.
  • number - Number
    Example: ABC-00001
paiddate
Paid Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
projectid
Project ID.
  • projectid - Attach Invoice to Project ID
    Example: 1
showcostbreakdown
Show Cost Breakdown (in main application).
  • true - Show Cost Breakdown
  • false - Hide Cost Breakdown
state
State.
  • state - State
    Example: Somewhere
status
Status.
  • unpaid - Unpaid
  • paid - Paid
taxable
Taxable status.
  • true - Taxable
  • false - Non-Taxable
taxrate
Tax rate.
  • number - Tax Rate (%)
    Example: 12.5
title
Title.
  • title - Title
    Example: Sample title
zipcode
Zipcode.
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Line Items in an Invoice

This call returns details of Line Items in an Invoice.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Add Line/s to an Invoice

This call adds Line/s to an Invoice.

The 'type' must be specified, the following must then be specified depending on the 'type':

  • 'heading' - Must provide 'name'
  • 'expense' - Must provide 'name' as well as 'quantity' & 'rate'
  • 'lineitem' - Must provide 'name' or 'description' as well as 'quantity' & 'rate'
  • 'staffrate' - Must provide 'name', 'time' & 'rate'
  • 'taskrate' - Must provide 'name', 'time' & 'rate'

Show Sample POST data

Single Line Item:
{
   "type":"lineitem",
   "name":"Line Item 1",
   "description":"Line Item 1 Description",
   "quantity":1,
   "rate":100.00,
   "taxable":true
}

Multiple Line Items:
[
   {
      "type":"heading",
      "name":"Redesign Work"
   },
   {
      "type":"lineitem",
      "name":"Line Item 1",
      "quantity":1,
      "rate":100.00,
      "taxable":true
   },
   {
      "type":"taskrate",
      "name":"Task Rate",
      "time":60,
      "rate":100.00,
      "taxable":false
   },
   {
      "type":"staffrate",
      "name":"Alex Trip",
      "time":60,
      "rate":100.00,
      "taxable":false
   }
]

REQUIRED PARAMETERS:

type
Type.
  • heading - Heading
  • lineitem - Line Item
  • staffrate - Staff Rate
  • taskrate - Task Rate

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

description
Description.
  • description - Description
    Example: Sample Description
displayorder
default: auto
Display Order
  • auto - Add as last Lines.
  • afterlineid - Add after 'lineid' in Invoice. Any existing Lines will be reordered automatically.
    Example: after1
  • beforelineid - Add before 'lineid' in Invoice. Any existing Tasks will be reordered automatically.
    Example: before1
  • number - Add Line with display order number 'number'.
    IMPORTANT: This option will NOT reorder any existing lines.
    Example: 1.1
name
Name.
  • name - Name
    Example: Sample name
quantity
Quantity.
  • quantity - Rate
    Example: 5
rate
Rate.
  • rate - Rate
    Example: 500.00
taxable
default: true
Taxable status.
  • true - Taxable
  • false - Non-Taxable
time
Time (minutes).
  • time - Rate
    Example: 120

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Line in an Invoice

This call returns details of a single Line in an Invoice.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Line from an Invoice

This call delete a single Line in an Invoice.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit a Line in an Invoice

This call updates a single Line in an Invoice.
Show Sample PUT data

{
   "rate":100.00,
   "taxable":false
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

description
Description.
  • description - Description
    Example: Sample Description
displayorder
Display Order
  • number - Update Line with display order number 'number'.
    IMPORTANT: This option will NOT reorder any existing lines.
    Example: 1.1
name
Name.
  • name - Name
    Example: Sample name
quantity
Quantity.
  • quantity - Rate
    Example: 5
rate
Rate.
  • rate - Rate
    Example: 500.00
taxable
Taxable status.
  • true - Taxable
  • false - Non-Taxable
time
Time (minutes).
  • time - Rate
    Example: 120

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Mark an Invoice as Paid

This call will mark a single Invoice as paid. You can specify 'paiddate' otherwise the current user's time is used.
Show Sample PUT data

{
   "paiddate":"2014-04-28"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

paiddate
Paid Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Mark an Invoice as Unpaid

This call will mark a single Invoice as unpaid.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Overdue Invoices

This call returns a list of overdue Invoices based on the filters specified and optionally subtotals based on the grouping options specified, it also returns the totals of all the returned quotes. The subtotals parameter allows you to return Sub Totals of invoiced amounts. The fields parameter allows you to return individual Invoices and choose which data fields to return for each Invoice. This call does not return details of the individual lines for each Invoice, you can use the specific Invoice call to return that information.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: number,title,company,projectid,invoiceddate,duedate,totals
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • company
    • dates (invoiced/due/paid)
    • duedate
    • emaileddate
    • emailedto
    • grandtotal
    • invoicedby
    • invoiceddate
    • lastmodified
    • number
    • paiddate
    • project (project id/title/number)
    • purchaseordernumber
    • status
    • subtotal
    • taxable
    • taxtotal
    • title
    • totals (sub/tax/grand totals)
    • xero (Staff only, requires Xero integration)
    Example: number,title,totals
  • none - return only Totals/Subtotals
subtotals
Sub Totals - specify required subtotals, if not specified then only Fields/Totals will be returned.
  • Comma separated list of any of the following in the required order:
    • company
    • project
    • status

    • day
    • week
    • month
    • year
    Use the 'subtotalsdateoption' to specify whether to group by invoiced, due or paid date (if week is used then the 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' date will be used as the first day of the week).
    Example: company,month - return Sub Totals of Invoiced amounts for each combination of Company and Month.
    NOTE - Only non-zero Sub Totals will be returned.
    IMPORTANT - To use date grouping options you must specify 'invoiceddatefrom' or 'duedatefrom' or 'paiddatefrom' depending on the option user for 'subtotalsdateoption'.

OPTIONAL PARAMETERS:

subtotalsdateoption
default: invoiced
Sub Totals Date Option - specify the date to group by when using a date option in the 'subtotals' option.
  • invoiced - Group by Invoiced Date
  • due - Group by Due Date
  • paid - Group by Paid Date

FILTER PARAMETERS:

apifields
API Field Value/s.
  • apifieldid,string - An API Field ID and String separated by a comma - Invoices where the field contains the specified string
    Example: 2,Europe
  • Multiple API Field ID and String pairs separated by two pipe characters
    NOTE: The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
    Example: 2,Europe||3,Industrial||3,Commercial
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Invoices where ANY of the specified apifields match
  • all - Invoices where ALL of the specified apifields match
companyid
Company ID or List of Company IDs.
  • companyid/s - Invoices in specified Company/ies
    Example: 1,2,3
divisionid
Division ID (Advanced plan only).
  • divisionid - Invoices in specified Division
    Example: 1
grandtotal
Invoice grandtotal.
  • number - Invoice Invoice Grand Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Grand Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Grand Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
idfrom
Invoices with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Invoices with ID greater than or equal to this value .
  • id - ID
    Example: 1
invoiceddatefrom
Invoices created on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
invoiceddateto
Invoices created on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
lastmodifiedfrom
Invoices added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Invoices added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Invoices for specified Project/s
    Example: 1,2
search
Search string.
  • string - Invoices where Number or Title contains string
    Example: website
  • !string - Invoices where Number and Title do not contain string
    Example: !layout
searchnumber
Search string.
  • string - Invoices where Number contains string
    Example: website
  • !string - Invoices where Number does not contain string
    Example: !layout
searchtitle
Search string.
  • string - Invoices where Title contains string
    Example: website
  • !string - Invoices where Title does not contain string
    Example: !layout
subtotal
Invoice Sub Total.
  • number - Invoice Sub Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Sub Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Sub Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00
taxable
default: all
Taxable status.
  • true - Taxable Invoices
  • false - Non-Taxable Invoices
  • all - All Invoices
taxtotal
Invoice Tax Total.
  • number - Invoice Invoice Tax Total is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Invoice Tax Total is GREATER THAN OR EQUAL to specified value
    Example: gte3000.00
  • ltenumber - Invoice Tax Total is LESS THAN OR EQUAL to specified value
    Example: lte3000.00

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Invoices.
Example: pagenumber=2&pagesize=10 (return Invoices 11-20). (Paging options are not available if you are using the 'subtotals' option)
  • pagenumber
pagesize
Page Size (must be used with pagenumber). (Paging options are not available if you are using the 'subtotals' option)
  • pagesize
sortby
default: number
Sort field.
  • id - Invoice ID
  • number - Invoice Title
  • title - Invoice Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending

DELETE PUT POST GET

Staff
Client
Contractor
Login Call

returns details about the user making the request and the account they are accessing. If you don't know your API key then you can use this call to return it by providing your Account URL (as well as using a Basic Authorization header).

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

url
Account URL.
  • string - Account URL
    Example: https://proworkflow6.net/ABCInc

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Contact Information

This call returns details of the Contact making the request.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit Contact Information

This call updatesthe Contact making the request.
Show Sample PUT data

{
   "firstname":"Adam",
   "lastname":"West"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

address1
Address Line 1
  • address1 - Address Line 1
    Example: 10 Phantom Road
address2
Address Line 2
  • address2 - Address Line 2
    Example: Fakeville
address3
Address Line 3
  • address3 - Address Line 3
    Example: Pretend Town
city
City
  • city - City
    Example: Somecity
country
Country
  • country - Country
    Example: Someland
email
Email Address
  • email - Email Address
    Example: noreply@proworkflow.com
firstname
First Name
  • firstname - First Name
    Example: Adam
lastname
Last Name
  • lastname - Last Name
    Example: West
mobilephone
Mobile Phone Number.
  • mobilephone - Mobile Phone Number
    Example: 0123 456 7890
password
Password
  • password - Password
    Example: p@55w0rd
state
State
  • state - State
    Example: Somewhere
title
Job Title
  • title - Title
    Example: CEO
username
Username
  • username - Username
    Example: adam
workphone
Work Phone Number
  • workphone - Work Phone Number
    Example: 0123 456 7890
zipcode
Zipcode
  • zipcode - Zip or Postal Code
    Example: 90210

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

DELETE PUT POST GET

Staff
Client
Contractor
View Messages

This call returns a list of Messages based on the filters specified. The fields parameter allows you to choose which data fields to return for each Message.
IMPORTANT: We recommend using the datefrom option to return only messages added in the timeframe you require.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,content,originalmessageid,project,task,date,author,contacts,public,files
Fields to return.
  • Comma separated list of any of the following:
    • author
    • contacts
    • content
    • date
    • files (returns list of any attached files)
    • originalmessageid (returns id of the message that started the discussion that this message replies to, returns blank string if this message started a new discussion)
    • project (includes id/number/title)
    • public (returns 'true' if message is public)
    • task (includes id/name)
    • title
    Example: author,title,content

OPTIONAL PARAMETERS:

contactdetails
default: false
Contact Details.
  • true - Return email, image, phone for contacts
  • false - Do not return email, image, phone for contacts

FILTER PARAMETERS:

contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Messages to/from specified Contact/s
    Example: 1,2
  • me - Messages to/from Contact making request
  • all - Messages for All Contacts
datefrom
Messages added on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dateto
Messages added on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
divisionid
Division ID (Advanced plan only).
  • divisionid - Messages in specified Division
    Example: 1
id
List of Message IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Messages with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Messages with ID greater than or equal to this value .
  • id - ID
    Example: 1
originalmessageid
Original Message ID.
  • originalmessageid - Messages in the discussion started by originalmessageid
    Example: 1
projectid
Project ID or List of Project IDs.
  • projectid/s - Project ID or List of Project IDs - Messages for specified Project/s
    Example: 1,2
projectstatus
default: active
Project Status.
  • active - Messages for Active Projects
  • complete - Messages for Completed Projects
  • all - Messages for All Projects
search
Search string.
  • string - Messages where Title contains string
    Example: website
  • !string - Messages where Title does not contain string
    Example: !layout
taskid
Task ID or List of Task IDs.
  • taskid/s - Task ID or List of Task IDs - Messages for specified Task/s
    Example: 1,2
taskstatus
default: all
Task Status.
  • active - Messages for Active Tasks
  • complete - Messages for Completed Tasks
  • all - Messages for All Tasks

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Messages.
Example: pagenumber=2&pagesize=10 (return Messages 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: id
Sort field.
  • id - Message ID
  • originalmessageid - Original Message ID
  • date - Message Date
  • projectid - Project ID
  • taskid - Task ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Message

This call adds a single message. A new discussion can be started by using the projectid or taskid parameter, a reply can be added by using the originalmessageid parameter. To attach files, they must first be uploaded and can then be attached to a message using the fileid parameter.
Show Sample POST data

{
   "contacts":"1,2",
   "projectid":1,
   "title":"New Message",
   "content":"Message Content",
   "fileid":"15"
}

REQUIRED PARAMETERS:

contacts
Contacts (required when starting a new discussion).
  • contactid/s - Contact ID or List of Contact IDs
    Example: 1,2
  • me - Contact making request
  • all - All Contacts Assigned to Project or Task
content
Content.
  • content - Content
    Example: Sample content
originalmessageid
Message ID (Specify to reply to an existing Discussion).
  • originalmessageid - Message ID
    Example: 1
projectid
Project ID (Specify to start a new Project Discussion).
  • projectid - Project ID
    Example: 1
taskid
Task ID (Specify to start a new Task Discussion).
  • taskid - Task ID
    Example: 1
title
Title (Required when starting a new discussion).
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

files
Files to attach to the Message (Files must belong to the same Project as the Message).
  • fileid/s - File ID or List of File IDs
    Example: 1,2
notifications
default: true
Notifications (Available when starting a new discussion).
  • true - Enable Email Notifications
  • false - Disable Email Notifications
public
default: true
Public Discussion.
  • true - Make Discussion Public
  • false - Make Discussion Private

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Message

This call returns details of a single Message.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

projectcontacts
default: false
Return project contacts.
  • true - Return project contacts
  • false - Do not return project contacts

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Message

This call deletes a single Message or Discussion, this is only available for messages added by the user making the request.
NOTE: Deleting the first message in a discussion will also delete all replies in that discussion.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit a Message

This call updates settings for a single Message, this is only available for messages added by the user making the request and that started a new discussion.
NOTE: The title or content of a message cannot be changed.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

contacts
Contacts
NOTE: You cannot remove contacts who have added a reply to the discussion.
  • contactid/s - Contact ID or List of Contact IDs
    Example: 1,2
  • me - Contact making request
  • all - All Contacts Assigned to Project or Task
notifications
Notifications
  • true - Enable Email Notifications
  • false - Disable Email Notifications
public
Public Discussion.
  • true - Make Discussion Public
  • false - Make Discussion Private

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

DELETE PUT POST GET

Staff
Client
Contractor
View Notes

This call returns a list of Notes. The fields parameter allows you to choose which data fields to return for each Note.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,content,category
Fields to return.
  • Comma separated list of any of the following:
    • content
    • category
    • contacts
    • date
    • lastmodified
    • title
    Example: title,content

OPTIONAL PARAMETERS:

contactdetails
default: false
Contact Details.
  • true - Return email, image, phone for contacts
  • false - Do not return email, image, phone for contacts

FILTER PARAMETERS:

categoryid
Category ID or List of Category IDs.
  • categoryid/s - Category ID or List of Category IDs - Notes for specified Category/ies
    Example: 1,2
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Notes for specified Contact/s
    Example: 1,2
  • me - Notes for Contact making request
  • all - Notes for All Contacts
datefrom
Notes added on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
dateto
Notes added on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
divisionid
Division ID.
  • divisionid - Notes for specified Division
    Example: 1
id
List of Note IDs.
  • id/s - ID
    Example: 1,2,3,4
idfrom
Notes with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Notes with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Notes added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Notes added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
search
Search string.
  • string - Notes where Title contains string
    Example: website
  • !string - Notes where Title does not contain string
    Example: !layout

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Notes.
Example: pagenumber=2&pagesize=10 (return Notes 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: date
Sort field.
  • id - Note ID
  • title - Note Title
  • date - Note Date
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Note

This call adds a Note.
Show Sample POST data

{
   "title":"New Note",
   "content":"Note Description",
   "categoryid":1,
   "contacts":"1,2,3"
}

REQUIRED PARAMETERS:

categoryid
Category ID.
  • categoryid - Category ID
    Example: 1
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Assign Note to specified Contact/s
    Example: 1,2
  • me - Assign Note to Contact making request
  • all - Assign Note to All Contacts
content
Content.
  • content - Content
    Example: Sample content
title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View a Note

This call returns a single Note.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Delete a Note

This call deletes a single Note.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
Edit a Note

This call updates a Note.
Show Sample PUT data

{
   "title":"New Note",
   "content":"Note Description"
}

REQUIRED PARAMETERS:

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

categoryid
Category ID.
  • categoryid - Category ID
    Example: 1
contacts
default: all
Contacts.
  • contactid/s - Contact ID or List of Contact IDs - Assign Note to specified Contact/s
    Example: 1,2
  • me - Assign Note to Contact making request
  • all - Assign Note to All Contacts
content
Content.
  • content - Content
    Example: Sample content
title
Title.
  • title - Title
    Example: Sample title

FILTER PARAMETERS:

SORT/PAGE PARAMETERS:

Staff
Client
Contractor
View Project Requests

This call returns a list of Project Requests based on the filters specified. The fields parameter allows you to choose which data fields to return for each Request.

REQUIRED PARAMETERS:

FIELD PARAMETERS:

fields
default: title,company,client,recipient,dates
Fields to return.
  • Comma separated list of any of the following:
    • apifieldX (returns API Field ID X, specify for each required Field)
    • apifields (returns all API Fields)
    • budget
    • client
    • company
    • customfields (Advanced plan only)
    • customform (Advanced plan only)
    • dates (returns start/due/submitted)
    • description
    • duedate
    • files
    • lastmodified
    • recipient (Advanced plan only)
    • startdate
    • submitteddate
    • template (Advanced plan only)
    • title
    Example: title,company,description

OPTIONAL PARAMETERS:

FILTER PARAMETERS:

apifields
API Field Value/s.
  • apifieldid,string - An API Field ID and String separated by a comma (Example: 2,Europe) - Requests where the field contains the specified string
  • Multiple API Field ID and String pairs separated by two pipe characters
    Example: 2,Europe||3,Industrial||3,Commercial
    The same API Field ID can be passed more than once to search for multiple values if apifieldsmode is set to any
apifieldsmode
default: any
Mode used for the apifields parameter.
  • any - Requests where ANY of the specified apifields match
  • all - Requests where ALL of the specified apifields match
budget
Requests where Budget matches criteria.
  • number - Budget is EXACTLY the specified value
    Example: 3000.00
  • gtenumber - Budget is GREATER THAN OR EQUAL to specified value
    Example: gte3000
  • ltenumber - Budget is LESS THAN OR EQUAL to specified value
    Example: lte3000
clientid
default: all
Client ID.
  • contactid/s - Contact ID or List of Contact IDs - Requests made by any of the specified Contact/s
    Example: 1,2
  • !contactid/s - Contact ID or List of Contact IDs - Requests NOT made by any of the specified Contact/s
    Example: !1,2
  • me - Requests made by Contact making request
  • all - All Requests
clienttype
default: all
Client Type (Advanced plan only).
  • external - External Project Requests
  • internal - Internal Project Requests
  • all - All Project Requests
companyid
Company ID.
  • companyid/s - Requests in specified Company/ies
    Example: 1,2,3
  • !companyid/s - Requests NOT for specified Company/ies
    Example: !1,2
customfields
Custom Field Value/s (Advanced plan only)
  • customfieldid,string - A Custom Field ID and String separated by a comma (Example: 2,Europe) - Requests with ANY/ALL specified ID and Value Pair/s (see customfieldsmode parameter)
  • Multiple Custom Field ID and String pairs separated by two pipe characters
    Example: 2,Europe||3,Industrial||3,Commercial
    The same Custom Field ID can be passed more than once to search for multiple values if customfieldsmode is set to any
customfieldsmode
default: any
Mode used for the customfields parameter.
  • any - Requests where ANY of the specified customfields match
  • all - Requests where ALL of the specified customfields match
divisionid
Division ID (Advanced plan only).
  • divisionid - Requests in specified Division
    Example: 1
duedatefrom
Requests with due date on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
duedateto
Requests with due date on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
idfrom
Requests with ID less than or equal to this value .
  • id - ID
    Example: 1
idto
Requests with ID greater than or equal to this value .
  • id - ID
    Example: 1
lastmodifiedfrom
Requests added/edited on or after this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
lastmodifiedto
Requests added/edited on or before this date.
  • Specific date & time - Date in ISO8601 (yyyy-mm-ddThh:mm) format
    Example: 2014-01-18T13:20
  • Xn/h/d/w/m - X minutes/hours/days/weeks/months ago
    Example: 12h
recipientid
default: all
Recipient ID (Advanced plan only).
  • recipientid/s - Contact ID or List of Contact IDs - Requests submitted to any of the specified Contact/s
  • !recipientid/s - Contact ID or List of Contact IDs - Requests NOT submitted to any of the specified Contact/s
  • me - Requests submitted to Contact making request
  • all - All Requests
searchcustomform
Search Custom Form (Advanced plan only).
  • string - Requests where Custom Form contains string
    Example: website
  • !string - Requests where Custom Form does not contain string
    Example: !layout
searchdescription
Search Description.
  • string - Requests where Description contains string
    Example: website
  • !string - Requests where Description does not contain string
    Example: !layout
searchtitle
Search Title.
  • string - Requests where Title contains string
    Example: website
  • !string - Requests where Title does not contain string
    Example: !layout
startdatefrom
Requests with start date on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
startdateto
Requests with start date on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
submitteddatefrom
Requests submitted on or after this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
submitteddateto
Requests submitted on or before this date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
templateid
Project Template ID (Advanced plan only).
  • templateid/s - Requests using specified Template IDs
    Example: 1,2,3
  • !templateid/s - Requests NOT using specified Template IDs
    Example: !1,2

SORT/PAGE PARAMETERS:

pagenumber
Page Number (must be used with pagesize) to return a subset of Requests.
Example: pagenumber=2&pagesize=10 (return Requests 11-20).
  • pagenumber
pagesize
Page Size (must be used with pagenumber).
  • pagesize
sortby
default: id
Sort field.
  • id - ID
  • title - Title
  • startdate - Start Date
  • duedate - Due Date
  • submitteddate - Submitted Date
  • companyid - Company ID
sortorder
default: asc
Sort order.
  • asc - Ascending
  • desc - Descending
Staff
Client
Contractor
Add a Project Request

This call adds a Project Request. Files can be added subsequently using the Add Files call with projectid set to the ID of the Project Request. In the Advanced Plan you may specify templateid to use a Project Template (any values you provide will override those in the Project Template). In the Advanced Plan you may specify contactid or divisionid (if neither is provided then the request will be submitted to the default contact for the same division as the user making the request). In the Advanced Plan you must specify groupid if the contactid you are submitting to belongs to more than 1 group.
Show Sample POST data

{
   "title":"Sample Request",
   "description":"Sample Request Description",
   "contactid":1,
   "startdate":"2014-04-18",
   "duedate":"2014-04-28",
   "customfields":
   [
      {
         "id":1,
         "value":"Europe"
      },
      {
         "id":2,
         "value":"Industrial"
      }
   ]
}

REQUIRED PARAMETERS:

title
Title.
  • title - Title
    Example: Sample title

FIELD PARAMETERS:

OPTIONAL PARAMETERS:

apifields
API Field Value/s
  • apifields - API Fields
    You must specify id and value (use the settings/apifields call for a list of fields).
    Example:
    [
    { "id":1, "value":"Europe"},
    { "id":2, "value":"Industrial"}
    ]
budget
Budget.
  • budget - Budget
    Example: 5000.00
contactid
Contact ID (Advanced plan only).
  • contactid - Contact ID
    Example: 1
customfields
Custom Field Value/s (Advanced plan only)
  • customfields - Custom Fields
    You must specify id and value (use the settings/projects/customfields call for a list of ids and values).
    Example:
    "customfields":
    [
    { "id":1, "value":"Europe"},
    { "id":2, "value":"Industrial"}
    ]
customformcontent
Custom Form Content (Advanced plan only).
  • customformcontent - Custom Form Content
    Example: Sample Form Content
customformtitle
Custom Form Title (Advanced plan only).
  • customformtitle - Custom Form Title
    Example: Sample Form Title
description
Description.
  • description - Description
    Example: Sample Description
divisionid
Division ID (Advanced plan only).
  • divisionid - Division ID
    Example: 1
duedate
Due Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
groupid
Group ID (Advanced Plan only, required if contactid belongs to more than 1 Group).
  • groupid - Group ID
    Example: 1
startdate
Start Date.
  • Specific date - Date in yyyy-mm-dd format
    Example: 2014-01-18
  • Relative date - +/-Xd/w/m/y
    Examples: -3w - 3 weeks ago OR +1m - 1 month ahead
templateid
Template ID (Advanced plan only).
  • templateid - Project Template ID
    Example: 1

FILTER PARAMETERS:

SORT/PAGE PARAMETERS: