Overview

The Nimble REST API lets you access your Nimble data — such as Users, Projects, Team Members, Cards, Comments, Attachments, Timesheet, ToDo, Parent-Child Relationships, and Dependency Relationships — programmatically from your own applications or integration tools, without signing in through the web interface each time. You can use it to read and update information, automate routine work, and connect Nimble with the other systems your team uses.

Integration Levels

You can build integrations on top of the Nimble REST API at two levels:

  • Organization-level Integration Resources — Users, Projects, and Team Members. These are currently supported via the Nimble REST API.
  • Project-level Integration Resources — Cards, Comments, Attachments, Timesheet, ToDo, Parent-Child Relationships, and Dependency Relationships. Support for project-level integration resources is planned for a future release.

Authentication: Generate Your API Key

Before you can call the Nimble REST API for Organization-level Integration Resources, you need an API key. The key is a secure token that authorizes your requests and carries the Administrator’s access permissions. Only an Administrator can generate an API key from the API Key Generation screen (Account Space > Administration > API Key Generation). Set an expiry date and copy the key when it is displayed. Learn how to generate an API key here.

Explore the REST APIs (Swagger)

Nimble provides an interactive API documentation (Swagger) page where you can browse all available Organization-level Integration Resource APIs and try them directly from your browser:

https://nimble.digite.com/apidocs/v2/saas/

To run an API from this page:

  1. Open the Swagger page using the link above.
  2. Click Authorize and paste the API key generated by your Administrator. This authenticates all the requests you make from this page.
  3. Expand the API you want to use (for example, Users) and select the specific endpoint.
  4. Click Try it out, fill in any required parameters, and click Execute.
  5. Review the response returned by Nimble, including the request URL, response body, and status code.

This lets you test how each Organization-level Integration Resource API behaves before using it in your own application or integration.

Important Points

  • The Nimble REST API currently supports Organization-level Integration Resources — Users, Projects, and Team Members. Project-level integration resources are planned for a future release.
  • Only an Administrator can generate an API key. The key carries the Administrator’s personal access permissions — it must be treated like a password and never shared.
  • Every REST API request must be authenticated with a valid API key. See API Key Generation.
  • The key stays valid until its expiry date. Once it expires, a new one must be generated to continue.
  • Always call the Nimble REST API over secure (HTTPS) connections.
  • Was this helpful?
  • Yes   No