{"id":24090,"date":"2026-08-20T11:53:10","date_gmt":"2026-08-20T06:23:10","guid":{"rendered":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/?post_type=article&p=24090"},"modified":"2026-10-09T12:49:49","modified_gmt":"2026-10-09T07:19:49","slug":"rest-api-client","status":"publish","type":"article","link":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/article\/rest-api-client\/","title":{"rendered":"REST API Client"},"content":{"rendered":"

Overview<\/h2>\n

The REST API Client<\/strong> lets you connect an external application \u2014 such as an automation script, CI\/CD pipeline, or integration service \u2014 to Nimble’s project-level resources using the Nimble REST API. It uses OAuth 2.0 client credentials, so the application authenticates on its own with no user login required at run time.<\/p>\n

Organization-level vs. project-level:<\/strong> This article covers the project-level<\/strong> resources of the Nimble REST API \u2014 instances, comments, attachments, to-dos, time entries, and related data \u2014 accessed using OAuth 2.0 client credentials. For organization-level<\/strong> resources (Users, Projects, and Team Members), which are accessed using an API key, see the Nimble REST API<\/a> article.<\/p>\n

When you register a REST API Client, Nimble generates a Client ID<\/strong> and a Client Secret<\/strong>. You use these credentials to get a short-lived access token, then include it on every API request.<\/p>\n

Base URL:<\/strong> https:\/\/api.digite.com\/rest\/v2<\/code><\/p>\n\n\n\n
\n

Skip Ahead to:<\/strong><\/p>\n

Register a REST API Client<\/a><\/p>\n

Get an Access Token<\/a><\/p>\n

Testing Your API Calls<\/a><\/p>\n

Scripts & Client Libraries<\/a><\/p>\n

Getting Started<\/a><\/p>\n

Workspaces<\/a><\/p>\n

Forms<\/a><\/p>\n

Instances<\/a><\/p>\n

Actor Object (User vs Client)<\/a><\/p>\n

Flags<\/a><\/p>\n

Blocks<\/a><\/p>\n

Votes<\/a><\/p>\n

Links<\/a><\/p>\n

Comments<\/a><\/p>\n

Attachments<\/a><\/p>\n

Todos<\/a><\/p>\n

Time Entries<\/a><\/p>\n

Boards<\/a><\/p>\n

Important Points<\/a><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/a>Register a REST API Client<\/h2>\n

Go to Account Space > Administration > REST API Client<\/strong>.<\/p>\n

\"REST<\/a><\/p>\n

    \n
  1. Click REGISTER<\/strong>.<\/li>\n
  2. Enter a Client Name<\/strong> and an optional Description<\/strong>. The Client ID<\/strong> is auto-generated (editable before saving).<\/li>\n<\/ol>\n

    \"Register<\/a><\/p>\n

      \n
    1. Expand Workspace Access Permissions<\/strong> and tick the operations this client is allowed to perform \u2014 Read Card<\/strong>, Create Card<\/strong>, Update Card<\/strong>, Close Card<\/strong>, Delete Card<\/strong> \u2014 for each workspace it needs access to. These permissions are granted per workspace<\/em>, so the same client can have different rights in different projects, and it can never do more through the API than the boxes you tick here.Example:<\/strong> a read-only reporting client that only pulls data from the Mobile Team<\/em> workspace would tick only Read Card<\/strong> for that workspace; a client that files and updates bugs would also tick Create Card<\/strong> and Update Card<\/strong>, while leaving Delete Card<\/strong> unticked so it can never remove work items.<\/li>\n<\/ol>\n

      \"Workspace<\/a><\/p>\n

        \n
      1. Click REGISTER CLIENT<\/strong>. Copy the Client Secret<\/strong> immediately \u2014 it is shown only once and cannot be retrieved again.<\/li>\n<\/ol>\n

        \"Client<\/a><\/p>\n

        Click DONE<\/strong>. The client appears in the list with edit and delete options.<\/p>\n

        \"REST<\/a><\/p>\n

        <\/a>Get an Access Token<\/h2>\n

        Why exchange credentials for a token?<\/h3>\n

        Every API call requires Authorization: Bearer <token><\/code>. Using a short-lived token instead of sending your secret on every request provides these security benefits:<\/p>\n