Supported Resources, Methods and API Features

The current scope of the REST API is limited to selected SuiteProjects Pro modules and object types.

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)					-
Bookings	-		-	-	-
Contacts
Customers	-		-	-
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)	-	-	-
Published reports^*	-		-	-	-
Receipts
Threaded discussion messages		(list of messages only)			-
Time entries			-
Users	-		-	-

Resources

POST

GET

PUT

DELETE

OPTIONS

Attachments

(Use the endpoints and methods specific to the object the attachments are associated with)

Check mark

Bookings

Check mark

Contacts

Check mark

Customers

Check mark

Expense reports

Check mark

Job codes

Check mark

Projects

Check mark

Project milestones

Check mark

(objects with Task classification set to 'Milestone' only)

Project phases

Check mark

(objects with Task classification set to 'Phase' only)

Project tasks

Check mark

(objects with Task classification set to 'Task' only)

Check mark

(objects with Task classification set to 'Task' only)

Published reports^*

Check mark

Receipts

Check mark

Threaded discussion messages

Check mark

(list of messages only)

Check mark

Time entries

Check mark

Users

Check mark

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)	-	-
Booking types (display name only)	-	-	-	-
Bookings					-
Contacts				-	-
Customers					-
Expense items (display name only)	-	-	-	-
Expense reports					-
Job codes				-	-
Job codes (display name only)	-	-	-	-
Projects					-
Project milestones					-
Project phases					-
Project stages (name only)	-	-	-	-
Project tasks					-
Published reports^*	-	(Only for rows of report data)	-	-	-
Receipts					-
Threaded messages					-
Time entries					-
Users					-
Users (display name only)	-	-	-	-
Workspaces	-	-	-	-

Resources

Filtering

Pagination

Sorting

Expansion (Endpoints)

Expansion (Referenced Objects)

Attachments

(Use the endpoints and methods specific to the object the attachments are associated with)

Check mark

Booking types (display name only)

Check mark

Bookings

Check mark

Contacts

Check mark

Customers

Check mark

Expense items (display name only)

Check mark

Expense reports

Check mark

Job codes

Check mark

Job codes (display name only)

Check mark

Projects

Check mark

Project milestones

Check mark

Project phases

Check mark

Project stages (name only)

Check mark

Project tasks

Check mark

Published reports^*

Check mark

(Only for rows of report data)

Receipts

Check mark

Threaded messages

Check mark

Time entries

Check mark

Users

Check mark

Users (display name only)

Check mark

Workspaces

Check mark

Note:

* - Published reports are available only if the Business Intelligence (BI) Connector feature is enabled for your account. You can access BI Connector resources even if API access and REST API are not enabled for your account.