Getting started

This documentation assumes that you have either signed up for a Resource Management by Smartsheet trial or you have an active subscription, and that you are familiar with the basic features of the application. The information that follows give you an overview of accessing the same functionality, from an API, so that you can implement additional functionality and custom integrations that meet your specific business needs.

We assume that you are familiar with basic RESTful API concepts.

Important:

Don't perform stress or performance testing in any account without informing > Resource Management by Smartsheet support and obtaining explicit approval. Violation of this may result in your account being suspended.

Here are some of the topics to help you get started:

• Authentication - The API uses service token-based authentication, which can be provided either in an HTTP header or as a URL query parameter named auth.

• Collections & Objects - The API uses a RESTful pattern to provide access to collections of objects via HTTP, which are always paginated and delivered in a JSON structure containing a data array and paging metadata.

• Pagination - The API uses pagination to manage large collections, allowing you to navigate through data pages using previous and next links and to customize the number of items per page with the per_page query parameter.

• Filtering - Some resources can be filtered using the filter_field and filter_list query parameters to match specific property values.

• Optional Fields - To reduce the number of API calls, you can include a comma-separated list of optional fields as a query parameter to fetch nested collections within a single request.

• Date & Time Formatting - The API requires dates to be in the YYYY-MM-DD format and time values to be in the YYYY-MM-DDTHH:MM:SSZ UTC format.

• Throttling & Rate-Limiting - The API throttles requests to ensure fair use and returns a 429 Too Many Requests response when a limit is exceeded, providing X-RateLimit-* headers to help you manage and handle the rate limit.