> ## Documentation Index
> Fetch the complete documentation index at: https://www.docusnap.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get asset

> Returns one asset with its **core fields** – without a wrapper, as a
single object. The type's data, the quick info, the blocks and the
child assets are not included; for those use `POST /assets/query` with
a filter on `id` and `expands`.

`select` limits the fields that are read; unselected ones are empty.

An asset the user cannot see yields `404`.

Permission: *Read*.




## OpenAPI

````yaml /api-reference/openapi.en.yaml get /asset/{id}
openapi: 3.0.4
info:
  title: Docusnap365 REST API
  version: v1
  description: |
    Public REST API of Docusnap365. Read access to a tenant's assets with
    filtering, sorting, cursor-based paging and loading of asset details
    (expands); write access through creating and updating assets.

    **Authentication.** API key in the `x-api-key` header. Owners and
    administrators create keys in Docusnap365 under *Administration ›
    Integrations › API Keys*, with the access *Read* or *Read and Write*. Read
    endpoints require *Read*, write endpoints require *Read and Write*.

    **Visibility.** The key belongs to a user, and that user's rights apply.
    Only what the user's filters on organization, platform, domain and
    location allow is returned. Missing rights do not raise an error – they
    yield a smaller result set. Only **active** assets are returned; deleted,
    archived and hidden ones cannot be reached, not even through a filter on
    `status`. Assets of a deactivated type are not returned.

    **Quota.** Every request counts against the subscription's quota (*API &
    MCP requests*). With a limited quota every response carries the headers
    `X-RateLimit-Limit`, `X-RateLimit-Remaining`,
    `X-RateLimit-Extra-Remaining` and `X-RateLimit-Reset`; once it is used up,
    the API answers `429` with `Retry-After`.

    **Errors.** All errors come as `application/problem+json` with
    `errorCode`, `errors[]` and `traceId`.
servers:
  - url: https://api.docusnap365.com/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Assets
    description: Read, query, create and update assets.
paths:
  /asset/{id}:
    get:
      tags:
        - Assets
      summary: Get asset
      description: |
        Returns one asset with its **core fields** – without a wrapper, as a
        single object. The type's data, the quick info, the blocks and the
        child assets are not included; for those use `POST /assets/query` with
        a filter on `id` and `expands`.

        `select` limits the fields that are read; unselected ones are empty.

        An asset the user cannot see yields `404`.

        Permission: *Read*.
      operationId: getAsset
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the asset.
          schema:
            type: string
            format: uuid
        - name: select
          in: query
          required: false
          description: JSON array of the fields to read.
          schema:
            type: string
          example: '["id","name","status"]'
      responses:
        '200':
          description: The asset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Asset:
      type: object
      description: >
        An asset's core fields. In `assets/query` with `select`, only the
        selected fields appear, plus the expands under their names
        (`object_data`, `object_essentials`, `object_blocks`, `children`);
        without `select` the expands sit under `expands`.
      properties:
        id:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
          nullable: true
        schemaId:
          type: string
          format: uuid
          description: Type of the asset.
        parentId:
          type: string
          format: uuid
          nullable: true
          description: Parent asset.
        name:
          type: string
        objectType:
          type: string
          description: Technical name of the type.
          example: basedef::windows
        type:
          type: string
          description: Display name of the type.
        iconId:
          type: string
          nullable: true
        sourceType:
          type: string
          example: manual
        organizationId:
          type: string
          format: uuid
          nullable: true
        locationId:
          type: string
          format: uuid
          nullable: true
        platformId:
          type: string
          format: uuid
          nullable: true
        domainId:
          type: string
          format: uuid
          nullable: true
        version:
          type: integer
          format: int32
        status:
          type: string
        isManually:
          type: boolean
        createdAt:
          type: string
          format: date-time
          nullable: true
        createdBy:
          type: string
          format: uuid
          nullable: true
        createdByDisplayName:
          type: string
          nullable: true
        modifiedAt:
          type: string
          format: date-time
          nullable: true
        modifiedBy:
          type: string
          format: uuid
          nullable: true
        modifiedByDisplayName:
          type: string
          nullable: true
        deletedAt:
          type: string
          format: date-time
          nullable: true
        deletedBy:
          type: string
          format: uuid
          nullable: true
        deletedByDisplayName:
          type: string
          nullable: true
        expands:
          type: object
          nullable: true
          description: Only without `select`. One list of entries per expand name.
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties: true
      additionalProperties: true
    Problem:
      type: object
      description: Error according to RFC 9457.
      properties:
        type:
          type: string
          example: urn:ds365:error:unknown-path
        title:
          type: string
          example: Unknown field path
        status:
          type: integer
          example: 400
        detail:
          type: string
        instance:
          type: string
          example: /api/v1/assets/query
        errorCode:
          type: string
          description: Meant for the application.
          example: UNKNOWN_PATH
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              path:
                type: string
                description: >-
                  Location in the request, such as `filter`, `sort`, `select` or
                  a parameter name.
              data:
                type: object
                additionalProperties: true
        traceId:
          type: string
          description: Quote it when contacting support.
  responses:
    BadRequest:
      description: >
        Invalid request – body unreadable, required field missing, unknown field
        (`UNKNOWN_PATH`), value does not fit the field (`FIELD_TYPE_MISMATCH`),
        operator does not fit (`UNSUPPORTED_OPERATOR`), `select`/`search` is not
        a JSON array (`INVALID_FORMAT`), unknown expand name
        (`VALIDATION_FAILED`), cursor damaged (`INVALID_CURSOR`) or expired
        (`CURSOR_EXPIRED`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: The request could not be assigned to a user (`UNAUTHORIZED`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >
        API key missing or without the required access (`FORBIDDEN`;
        `data.missingScopes` names what is missing) – or the cursor belongs to
        another user or tenant (`CURSOR_USER_MISMATCH`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: >
        No asset with this ID among the visible assets (`NOT_FOUND`,
        `data.entityType` = `asset`, `data.id`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: >
        Quota used up (`REST_REQUEST_QUOTA_EXCEEDED`); the request was not
        executed and still counted.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Extra-Remaining:
          $ref: '#/components/headers/RateLimitExtraRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: urn:ds365:error:rest-request-quota-exceeded
            title: Request quota exceeded
            status: 429
            detail: >-
              The request quota of 10000 requests per period is exhausted until
              2026-10-17T09:52:44.0000000+00:00.
            instance: /api/v1/assets
            errorCode: REST_REQUEST_QUOTA_EXCEEDED
            errors:
              - code: REST_REQUEST_QUOTA_EXCEEDED
                data:
                  requestsLimit: 10000
                  requestsUsed: 10000
                  quotaResetAt: '2026-10-17T09:52:44+00:00'
            traceId: 00-…
    ServerError:
      description: >-
        Unexpected error (`INTERNAL_ERROR`). Quote the `traceId` when contacting
        support.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ServiceUnavailable:
      description: >
        The quota could not be checked (`SERVICE_UNAVAILABLE`); the request was
        not executed. Retry later.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  headers:
    RetryAfter:
      description: Start of the next period as an HTTP date.
      schema:
        type: string
    RateLimitLimit:
      description: Requests included in the period. Absent without a limit.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests still available, included and purchased together.
      schema:
        type: integer
    RateLimitExtraRemaining:
      description: Of these, the purchased extra quota still available.
      schema:
        type: integer
    RateLimitReset:
      description: Start of the next period as a Unix timestamp (seconds).
      schema:
        type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        API key from Docusnap365 (*Administration › Integrations › API Keys*).
        Read endpoints require the access *Read*, write endpoints *Read and
        Write*.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.