Get Assets

GET

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

GET

/api/v2/assets

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

200Retrieved

[
  {
    "id": "string",
    "identifier": "string",
    "serial": "string",
    "location_id": "string",
    "parent_id": "string",
    "manufacturer_detail_id": "string",
    "make_detail_id": "string",
    "model_detail_id": "string",
    "editable": true,
    "location": {
      "id": "string",
      "name": "string",
      "address": "string",
      "company_id": "string",
      "company_name": "string",
      "archived": true,
      "external_id": "string",
      "custom_fields": [
        {
          "id": "string",
          "custom_field_definition_id": "string",
          "name": "string",
          "value": "string",
          "created_at": 1,
          "updated_at": 1
        }
      ],
      "can_manage": true,
      "created_at": 1,
      "updated_at": 1
    },
    "make_detail": {
      "id": "string",
      "value": "string",
      "detail_type": "string",
      "created_at": 1,
      "updated_at": 1
    },
    "manufacturer_detail": {
      "id": "string",
      "value": "string",
      "detail_type": "string",
      "created_at": 1,
      "updated_at": 1
    },
    "model_detail": {
      "id": "string",
      "value": "string",
      "detail_type": "string",
      "created_at": 1,
      "updated_at": 1
    },
    "status": {
      "id": "string",
      "description": "string",
      "downtime_type": "string",
      "status_name": "string",
      "status_type": "string",
      "normalised_status_name": "string",
      "started_at": 1,
      "created_at": 1,
      "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
      },
      "updated_at": 1
    },
    "custom_fields": [
      {
        "id": "string",
        "custom_field_definition_id": "string",
        "name": "string",
        "value": "string",
        "created_at": 1,
        "updated_at": 1
      }
    ],
    "custom_field_definitions": [
      {
        "id": "string",
        "name": "string",
        "customisable_entity_name": "string",
        "field_type": "string",
        "required": true,
        "options": [
          "string"
        ],
        "sort_order": 1,
        "created_at": 1,
        "updated_at": 1,
        "position": 1
      }
    ],
    "related_assets": [
      null
    ],
    "documents": [
      {
        "id": "string",
        "category": {
          "id": "string",
          "name": "string",
          "created_at": 1,
          "updated_at": 1
        },
        "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
        },
        "file": {
          "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
      }
    ],
    "created_at": 1,
    "updated_at": 1
  }
]

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

location_idsstringOptional

include_detailsbooleanOptional

include_parentbooleanOptional

include_locationbooleanOptional

include_statusbooleanOptional

Response

get Asset(s)

idstringOptional

ULID

identifierstringOptional

serialstringOptional

location_idstringOptional

ULID

parent_idstringOptional

ULID

manufacturer_detail_idstringOptional

ULID

make_detail_idstringOptional

ULID

model_detail_idstringOptional

ULID

editablebooleanOptional

locationobjectOptional

make_detailobjectOptional

manufacturer_detailobjectOptional

model_detailobjectOptional

statusobjectOptional

parentobjectOptional

custom_fieldslist of objectsOptional

custom_field_definitionslist of objectsOptional

related_assetslist of objectsOptional

documentslist of objectsOptional

Present when include_documents=true

created_atlongOptional

Unix timestamp (seconds since epoch) when the record was created

updated_atlongOptional

Unix timestamp (seconds since epoch) when the record was last updated