REST API

SuiteProjects Pro REST API provides an interface for integration applications to exchange information with SuiteProjects Pro.

The REST API:

• Is organized around REST.

• Uses predictable resource-oriented URLs.

• Accepts JSON-encoded request bodies.

• Returns JSON-encoded responses.

• Uses standard HTTP response codes, authentication and verbs.

The REST API lets you:

• Use CRUD (create, read, update, delete) operations on SuiteProjects Pro records.

• Retrieve a list of records from a collections and use pagination.

• Filter SuiteProjects Pro record collections.

The REST API is a service layer that is built on top of the business layer in SuiteProjects Pro. This ensures that business rules configured for your SuiteProjects Pro account are applied when an integration application interacts with your SuiteProjects Pro data through the REST API. Business rules include SuiteProjects Pro account configuration settings and access control mechanisms, as well as any user scripts deployed on your from the company's SuiteProjects Pro account.

The REST API supports OAuth 2.0 exclusively for authentication and authorization, which is a more robust and reliable way to access data.

If the REST API is enabled for your account, account administrators and employees with the Export data role permission can access the REST API definition in OpenAPI 3.0 JSON format. The generated documentation includes a full REST API reference including resource descriptions, endpoints and methods, parameters, request body and response examples and schema.

To enable the REST API, contact SuiteProjects Pro Support.