Release History

October 12, 2024

• Added the following resources:

  • Customer — See Customers and Customer object properties.

  • PublishedReport — See Published Reports.

  • User — See Users and User object properties.

• Added the following endpoints and methods:

  • GET​ /customers/ — See Get the List of Customers

  • GET​ /customers/{id} — See Get a Customer

  • OPTIONS /customers/ — See Discover Available Methods and Fetch the Endpoint Reference for Customers

  • GET​ /published-reports/ — See Get the List of Published Reports

  • GET​ /published-reports/{id} — See Get a Published Report

  • GET​ /users/ — See Get the List of Users

  • GET​ /users/{id} — See Get a User

  • OPTIONS /users/ — See Discover Available Methods and Fetch the Endpoint Reference for Users

• The Referenced Objects and Expansion feature can be used to expand the name of the referenced project stage when reading projects. The expand parameter now supports the Project attribute projectStageId. The response includes projectStageName objects expanded object, which are available only as an expanded object. See Referenced Objects and Expansion.

April 13, 2024

No changes in this release.

October 7, 2023

• Added the following resource:

  TimeEntry — See Time Entries and Time entry object properties.

• Added the following endpoints and methods:

  • PUT /expense-reports​/{id}/attachments/{attachment_id} — See Replace an Attachment to an Expense Report

  • PUT /projects​/{id}/attachments/{attachment_id} — See Replace an Attachment to a Project

  • GET​ /project-tasks​/{id}​/attachments/{attachment_id}/thumbnail — See Get the Thumbnail for an Attachment Associated with a Project Task

  • PUT /project-tasks​/{id}/attachments/{attachment_id} — See Replace an Attachment to a Project Task

  • PUT /receipts​/{id}/attachments/{attachment_id} — See Replace an Attachment to a Receipt

  • POST /time-entries/ — See Insert a Time Entry

  • GET /time-entries/ — See Get the List of Time Entries

  • GET /time-entries/{id} — See Get a Time Entry

  • DELETE /time-entries/{id} — See Delete a Time Entry

  • OPTIONS /time-entries/ — See Discover Available Methods and Fetch the Endpoint Reference for Time Entries

• The following methods also support the Sorting feature:

  • GET​ /expense-reports​/{id}​/attachments/ — See Get the List of Attachments Associated with an Expense Report.

  • GET​ /projects​/{id}​/attachments — See Get the List of Attachments Associated with a Project

  • GET​ /project-tasks​/{id}​/attachments — See Get the List of Attachments Associated with a Project Task

  • GET​ /receipts​/{id}​/attachments/ — See Get the List of Attachments Associated with a Receipt.

April 15, 2023

• Support for automatically generated thumbnail image when adding an attachment (Attachment Thumbnail feature). See Add an Attachment to an Expense Report, Add an Attachment to a Project, Add an Attachment to a Project Task, Add an Attachment to a Receipt.

• Added the following endpoints and methods:

  • GET​ /expense-reports​/{id}​/attachments/{attachment_id}/thumbnail — See Get the Thumbnail for an Attachment Associated with an Expense Report

  • GET​ /projects​/{id}​/attachments/{attachment_id}/thumbnail — See Get the Thumbnail for an Attachment Associated with a Project

  • GET​ /receipts​/{id}​/attachments/{attachment_id}/thumbnail — See Get the Thumbnail for an Attachment Associated with a Receipt

• Added support for sorting returned list of resources in ascending or descending sort order (single sorting level). The Sorting feature supports the following methods:

  • GET /contacts/ — See Get the List of Contacts

  • GET ​/expense-reports​/ — See Get the List of Expense Reports

  • GET​ /expense-reports​/{id}​/receipts — See Get the List of Receipts in an Expense Report

  • GET /job-codes/ — See Get the List of Job Codes

  • GET​ /projects/ — See Get the List of Projects

  • GET​ /project-milestones/ — See Get the List of Project Milestones

  • GET​ /project-phases/ — See Get the List of Project Phases

  • GET​ /project-tasks/ — See Get the List of Project Tasks

  • GET​ /receipts/ — See Get the List of Receipts

• Added Attachment object property isViewable indicating if the attachment is viewable in the Attachment Viewer feature — See Attachments.

October 8, 2022

• Added the following resources:

  • ProjectMilestone — See ProjectMilestone Object Properties.

  • ProjectPhase — See ProjectPhase Object Properties.

  • ProjectTask — See ProjectTask Object Properties.

• Added the following endpoints and methods:

  • POST​ /projects/from-template/ — See Create a Project from Template

  • POST​ /projects​/{id}​/attachments — See Add an Attachment to a Project

  • GET​ /projects​/{id}​/attachments — See Get the List of Attachments Associated with a Project

  • GET​ /projects​/{id}​/attachments/{attachment_id} — See Get an Attachment Associated with a Project

  • GET​ /projects​/{id}​/attachments/{attachment_id}/download — See Get an Attachment File Associated with a Project

  • DELETE​ /projects​/{id}​/attachments/{attachment_id} — See Delete an Attachment Associated with a Project

  • DELETE​ /projects​/{id}​/attachments/{attachment_ids} — See Delete Attachments Associated with a Project

  • GET​ /project-milestones/ — See Get the List of Project Milestones

  • GET​ /project-milestones/{id} — See Get a Project Milestone

  • GET​ /project-phases/ — See Get the List of Project Phases

  • GET​ /project-phases/{id} — See Get a Project Phase

  • POST​ /project-tasks/ — See Insert a Project Task

  • GET​ /project-tasks/ — See Get the List of Project Tasks

  • GET​ /project-tasks/{id} — See Get a Project Task

  • POST​ /project-tasks​/{id}​/attachments — See Add an Attachment to a Project Task

  • GET​ /project-tasks​/{id}​/attachments — See Get the List of Attachments Associated with a Project Task

  • GET​ /project-tasks​/{id}​/attachments/{attachment_id} — See Get an Attachment Associated with a Project Task

  • GET​ /project-tasks​/{id}​/attachments/{attachment_id}/download — See Get an Attachment File Associated with a Project Task

  • DELETE​ /project-tasks​/{id}​/attachments/{attachment_id} — See Delete an Attachment Associated with a Project Task

  • DELETE​ /project-tasks​/{id}​/attachments/{attachment_ids} — See Delete Attachments Associated with a Project Task

• The filterSetId query string parameter can be used to specify the internal ID of the filter set to be applied when inserting or updating objects using a POST or PUT method or deleting an object using the DELETE method. All available REST API resources and CRUD methods now support the parameter. See Active Filter Set, Errors and all POST, PUT, and DELETE methods in REST API Endpoint Reference.

• The Filtering and Pagination features are supported when working with Contacts and Job Codes using the REST API. See Supported Resources, Methods and API Features.

April 9, 2022

• Added the following endpoints and methods:

  • POST​ /projects/ — See Insert a Project

  • POST ​/projects​/bulk/ — See Insert Multiple Projects

  • PUT​ /projects/{id} — See Update a Project

  • PUT​ /projects/bulk/{ids} — See Update Multiple Projects

  • DELETE​ /projects/{id} — See Delete a Project

  • DELETE​ /projects/bulk/{ids} — See Delete Multiple Projects

• Added request query string parameter filterSetId to specify the internal ID of the filter set to be applied when retrieving data using a GET method. See Active Filter Set, Errors and all GET methods in REST API Endpoint Reference.

• Changes to Project object properties:

  • Added properties filterSetIds (filter sets the project is included in) and hierarchyNodes (project hierarchy nodes, available when reading, updating or creating projects).

  • Removed properties costTypeFilter, customerExcludeFilter, projectExcludeFilter — These fields are part of a feature that is not supported by the REST API.

• Changes to Referenced Objects and Expansion:

  • The number of expanded objects that can be returned in the included array is limited to 1,000 objects by default.

  • If expanded objects are referenced by metavalues (negative integers) instead of internal IDs in the main response element (data array), the response substitutes the object internal IDs for metavalue references in the relationships array.

October 9, 2021

• Added the following endpoints and methods:

  • GET​ /projects/ — See Get the List of Projects

  • GET​ /projects/{id} — See Get a Project

  • OPTIONS /projects/ — See Discover Available Methods and Fetch the Endpoint Reference for Projects

  • DELETE​ /receipts​/{id} — See Delete a Receipt

• Added support for deleting multiple expense attachments. Updated the following methods:

  • DELETE​ /expense-reports​/{id}​/attachments/{attachment_ids} — See Delete Attachments Associated with an Expense Report.

  • DELETE​ /receipts​/{id}​/attachments/{attachment_ids} — See Delete Attachments Associated with a Receipt.

• The /attachments/{id} and /attachments/{id}/download endpoints were removed from the REST API. To work with attachments, use the endpoints and methods specific to the object the attachments are associated with. See Attachments.

• OAuth 2.0 access token validity period cannot be greater than session timeout — See Application Configuration.

• OAuth 2.0 refresh token validity period can be between 1 and 31 days in one–day increments — sSee Application Configuration.

April 10, 2021

• The service path for the REST API is /rest/v1/ instead of /webapi/v2/ — See Request URL.

• Added the following methods:

  • OPTIONS /contacts/ — See Discover Available Methods and Fetch the Endpoint Reference for Contacts.

  • POST​ /expense-reports​/{id}​/attachments/ — See Add an Attachment to an Expense Report.

  • GET​ /expense-reports​/{id}​/attachments/ — See Get the List of Attachments Associated with an Expense Report.

  • GET​ /expense-reports​/{id}​/attachments/{attachment_id} — See Get an Attachment Associated with an Expense Report.

  • GET​ /expense-reports​/{id}​/attachments/{attachment_id}/download — See Get an Attachment File Associated with an Expense Report.

  • DELETE​ /expense-reports​/{id}​/attachments/{attachment_id} — See Delete Attachments Associated with an Expense Report.

  • OPTIONS /expense-reports/ — See Discover Available Methods and Fetch the Endpoint Reference for Expense Reports.

  • OPTIONS /job-codes/ — See Discover Available Methods and Fetch the Endpoint Reference for Job Codes.

  • POST​ /receipts​/{id}​/attachments/ — See Add an Attachment to a Receipt.

  • GET​ /receipts​/{id}​/attachments/ — See Get the List of Attachments Associated with a Receipt.

  • GET​ /receipts​/{id}​/attachments/{attachment_id} — See Get an Attachment Associated with a Receipt.

  • GET​ /receipts​/{id}​/attachments/{attachment_id}/download — See Get an Attachment File Associated with a Receipt.

  • DELETE​ /receipts​/{id}​/attachments/{attachment_id} — See Delete Attachments Associated with a Receipt.

  • OPTIONS /receipts/ — See Discover Available Methods and Fetch the Endpoint Reference for Receipts.

• Added the following resource object attributes:

  Attachment — Added the workspaceId attribute, the internal ID of the workspace associated with the attachment. The value is 0 (zero) if the attachment is not associated with a workspace. See Attachment object properties.

• Added support for expanding objects referenced by internal ID in the main response elements (data array) — If there are any attributes available for expansion, the response automatically includes a relationships property in the response metadata (meta object) with information about the attributes available for expansion and the referenced objects. The expand query parameter can be used to return expanded objects of type attachment, userDisplayName, and workspace in the included response property without the need for separate requests. Some of this additional data is only available when using expansion. See Referenced Objects and Expansion.

• Added Auditing and Managing OAuth 2.0 Authorizations under OAuth 2.0 Authorization — Account administrators can use web services reports to audit and revoke authorizations granted by OpenAir users to integration applications.

October 10, 2020

• Initial version of REST API released.