Get Instruction Suggestions

GET

https://app.hindsiteind.com/api/v2/instruction_suggestions

GET

/api/v2/instruction_suggestions

curl https://app.hindsiteind.com/api/v2/instruction_suggestions \
     -H "Authorization: Bearer <token>"

{
  "results": [
    {
      "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
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_pages": 1,
    "total_count": 1
  },
  "status_counts": {
    "open": 1,
    "reviewed": 1
  }
}

Lists the instruction suggestions the caller can see, newest first and ten per page, with open and reviewed counts; only open suggestions are returned unless completed=true is passed.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

Request API credentials from HINDSITE support to receive your client_id and client_secret
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

The response will contain your access token:

{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}

Include the token in subsequent API requests:

Authorization: Bearer your_access_token_here

Query parameters

pageintegerOptionalDefaults to 1

Page number. Each page holds 10 suggestions.

completedbooleanOptionalDefaults to false

true returns reviewed suggestions; false or omitted returns open suggestions. There is no way to list both at once.

Response

Paginated instruction suggestions with status counts

resultslist of objectsOptional

Each suggestion carries user; instruction_label, instruction_step_label, notes and attachments are omitted.

metaobjectOptional

status_countsobjectOptional

Counts across every suggestion the caller can see, ignoring the completed filter.

Errors

402

Payment Required Error