> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.hindsiteind.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.hindsiteind.com/_mcp/server.

# Get Instruction Suggestions Id

GET https://app.hindsiteind.com/api/v2/instruction_suggestions/{id}

Returns one instruction suggestion the caller can see, with its author, notes, attachments and the instruction and step it was raised on.

Reference: https://api-docs.hindsiteind.com/hindsite-api/instruction-suggestions/get-instruction-suggestions-id

## Authentication

- `Authorization` header (bearer token, required) — OAuth 2.0 Client Credentials Flow. To obtain an access token: 1. Request API credentials from HINDSITE support to receive your `client_id` and `client_secret` 2. Make a POST request to obtain an access token: ``` POST https://app.hindsiteind.com/oauth/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET ``` 3. The response will contain your access token: ```json { "access_token": "your_access_token_here", "token_type": "Bearer", "expires_in": 7200, "created_at": 1234567890 } ``` 4. Include the token in subsequent API requests: ``` Authorization: Bearer your_access_token_here ```

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

get InstructionSuggestion

- `id` (string, optional) — ULID
- `title` (string, optional)
- `description` (string, optional, nullable)
- `completed` (boolean, optional) — True once the suggestion has been reviewed.
- `mentionable` (boolean, optional) — Whether users can be mentioned in notes on this suggestion. Currently always true.
- `user_id` (string, optional) — ULID of the user who raised the suggestion.
- `instruction_step_uuid` (string, optional) — The step's `step_uuid`, which stays the same across revisions. Not an instruction step ID.
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)
- `instruction_label` (string, optional) — Title of the instruction, or of the step group prefixed with its label, the suggestion was raised on. Present only on GET /api/v2/instruction\_suggestions/\{id}.
- `instruction_step_label` (string, optional, nullable) — The step's title, falling back to its description. Present only on GET /api/v2/instruction\_suggestions/\{id}.
- `user` (User, optional) — The user who raised the suggestion. Present on the list and GET /api/v2/instruction\_suggestions/\{id}.
- `notes` (list of Note, optional) — Present only on GET /api/v2/instruction\_suggestions/\{id}.
- `attachments` (list of Content, optional) — Files attached when the suggestion was raised. Present only on GET /api/v2/instruction\_suggestions/\{id}.

## Errors

### 402 Payment Required Error

The organisation's plan does not include instruction suggestions. The body carries `error`, `feature` (`instruction_suggestions`) and an `upgrade_url`.

- `error` (string, optional)
- `feature` (enum, optional)
  - Allowed values: `instruction_suggestions`
- `upgrade_url` (string, optional)

### 404 Not Found Error

The suggestion does not exist or the caller cannot see it. The body carries an `error` message.

- `error` (string, optional)

## Types

### User

- `id` (string, optional) — ULID
- `email` (string, optional)
- `name` (string, optional)
- `is_admin` (boolean, optional)
- `location_manager` (boolean, optional)
- `last_active_at` (long, optional) — Unix timestamp (seconds since epoch)
- `archived` (boolean, optional)
- `organisation_id` (string, optional) — ULID
- `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created
- `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated

### Note

- `id` (string, optional) — ULID
- `content` (string, optional) — Sanitized HTML content
- `plain_text_content` (string, optional)
- `user` (User, optional)
- `noteable_type` (string, optional)
- `noteable_id` (string, optional) — ULID
- `attachments` (list of ActiveStorageBlob, optional)
- `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created
- `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated

### Content

- `id` (long, optional) — Content ID. An integer, not a ULID.
- `original` (string, optional) — Presigned URL
- `versions` (list of string, optional)
- `thumbnails` (list of string, optional)
- `title` (string, optional)
- `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created
- `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated

### ActiveStorageBlob

- `blob_url` (string, optional)
- `signed_id` (string, optional)
- `filename` (string, optional)
- `byte_size` (integer, optional)
- `content_type` (string, optional)
- `preview_url` (string, optional) — Poster image URL. Present only for previewable blobs (e.g. video).
- `key` (string, optional) — Storage key of the file in Hindsite's file store. Opaque; download the file with blob_url.
- `direct_upload` (ActiveStorageBlobDirectUpload, optional) — Only present on the POST /api/v2/active_storage/presign and POST /api/v2/active_storage/direct_uploads responses, which omit preview_url. PUT the file bytes to url with headers, then reference the blob by signed_id.

### ActiveStorageBlobDirectUpload

Only present on the POST /api/v2/active_storage/presign and POST /api/v2/active_storage/direct_uploads responses, which omit preview_url. PUT the file bytes to url with headers, then reference the blob by signed_id.

- `url` (string, optional) — Pre-signed upload URL, valid for 30 minutes
- `headers` (map from string to string, optional) — HTTP headers to send with the upload, such as Content-Type and Content-MD5

## Examples

**Response**

```json
{
  "id": "string",
  "title": "string",
  "description": "string",
  "completed": true,
  "mentionable": true,
  "user_id": "string",
  "instruction_step_uuid": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "instruction_label": "string",
  "instruction_step_label": "string",
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "is_admin": true,
    "location_manager": true,
    "last_active_at": 1,
    "archived": true,
    "organisation_id": "string",
    "created_at": 1,
    "updated_at": 1
  },
  "notes": [
    {
      "id": "string",
      "content": "string",
      "plain_text_content": "string",
      "user": {
        "id": "string",
        "email": "string",
        "name": "string",
        "is_admin": true,
        "location_manager": true,
        "last_active_at": 1,
        "archived": true,
        "organisation_id": "string",
        "created_at": 1,
        "updated_at": 1
      },
      "noteable_type": "string",
      "noteable_id": "string",
      "attachments": [
        {
          "blob_url": "string",
          "signed_id": "string",
          "filename": "string",
          "byte_size": 1,
          "content_type": "string",
          "preview_url": "string",
          "key": "string",
          "direct_upload": {
            "url": "string",
            "headers": {}
          }
        }
      ],
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "attachments": [
    {
      "id": 1,
      "original": "string",
      "versions": [
        "string"
      ],
      "thumbnails": [
        "string"
      ],
      "title": "string",
      "created_at": 1,
      "updated_at": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://app.hindsiteind.com/api/v2/instruction_suggestions/id"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.hindsiteind.com/api/v2/instruction_suggestions/id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.hindsiteind.com/api/v2/instruction_suggestions/id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.hindsiteind.com/api/v2/instruction_suggestions/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.hindsiteind.com/api/v2/instruction_suggestions/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.hindsiteind.com/api/v2/instruction_suggestions/id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.hindsiteind.com/api/v2/instruction_suggestions/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.hindsiteind.com/api/v2/instruction_suggestions/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```