Supported Resources, Methods and API Features

The current scope of the REST API is limited to selected OpenAir modules and entities.

The following table summarizes the methods available for supported resources. For more information about the endpoints and methods, see REST API Endpoint Reference.

Resources	POST	GET	PUT	DELETE	OPTIONS
Attachments (Use the endpoints and methods specific to the object the attachments are associated with)					—
Contacts
Expense reports
Job codes
Projects
Project milestones	—	(objects with Task classification set to “Milestone” only)	—	—	—
Project phases	—	(objects with Task classification set to “Phase” only)	—	—	—
Project tasks	(objects with Task classification set to “Task” only)	(objects with Task classification set to “Task” only)	—	—	—
Receipts
Time entries			—

The following table summarizes the API features available for supported resources. It includes two columns for the Expansion feature to show the resource endpoints for which the feature is available, and the referenced objects that can be expanded.

• For more information about the Filtering feature, see Filtering.

• For more information about the Pagination feature, see Pagination.

• For more information about the Sorting feature, see Sorting.

• For more information about the Expansion feature, see Referenced Objects and Expansion.

Resources	Filtering	Pagination	Sorting	Expansion (Endpoints)	Expansion (Referenced Objects)
Attachments (Use the endpoints and methods specific to the object the attachments are associated with)	—	—
Contacts				—	—
Expense reports					—
Job codes				—	—
Projects					—
Project milestones					—
Project phases					—
Project tasks					—
Receipts					—
Time entries					—
Users (display name only)	—	—	—	—
Workspaces	—	—	—	—