curl --request POST \
  --url https://api.docusnap365.com/api/v1/assets/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "select": [
    "id",
    "name",
    "createdAt"
  ],
  "filter": {
    "logic": "And",
    "conditions": [
      {
        "path": "name",
        "op": "Contains",
        "value": "server"
      }
    ]
  },
  "sort": [
    {
      "path": "createdAt",
      "desc": true
    }
  ],
  "limit": 20
}
'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "objectType": "<string>",
      "type": "<string>",
      "iconId": "<string>",
      "sourceType": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "status": "<string>",
      "isManually": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdByDisplayName": "<string>",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modifiedByDisplayName": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedByDisplayName": "<string>",
      "expands": {}
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true,
  "incompleteExpands": {}
}

{
  "type": "urn:ds365:error:unknown-path",
  "title": "Unknown field path",
  "status": 400,
  "detail": "Field 'hostname' is not configured for source 'objects'",
  "instance": "/api/v1/assets/query",
  "errorCode": "UNKNOWN_PATH",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "UNKNOWN_PATH",
      "path": "filter",
      "data": {
        "field": "hostname",
        "source": "objects",
        "origin": "filter"
      }
    }
  ]
}

{
  "type": "urn:ds365:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Missing required scopes: api_read",
  "instance": "/api/v1/assets",
  "errorCode": "FORBIDDEN",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "FORBIDDEN",
      "data": {
        "missingScopes": [
          "api_read"
        ]
      }
    }
  ]
}

{
  "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-12-01T00:00:00.0000000+00:00.",
  "instance": "/api/v1/assets",
  "errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "REST_REQUEST_QUOTA_EXCEEDED",
      "data": {
        "requestsLimit": 10000,
        "requestsUsed": 10000,
        "quotaResetAt": "2026-12-01T00:00:00+00:00"
      }
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

Query

Query assets

Queries assets with filter, sort, field selection, page size and expands.

Only the fields of the asset are available for select, filter and sort (see AssetDto). Expands add related data; data. paths in an expand are resolved against the types.

With select the response items contain only the selected properties, and the expands are lifted to the top level of the item. Without select an item is the complete asset with its expands in expands.

A page holds limit items (default 50). If more exist, hasMore is true and nextCursor continues with POST /cursor/continue. An expand that holds more rows than its limit for an asset is reported in incompleteExpands; continue it with POST /assets/expand.

Requires the scope api_read (Read).

POST

assets

query

curl --request POST \
  --url https://api.docusnap365.com/api/v1/assets/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "select": [
    "id",
    "name",
    "createdAt"
  ],
  "filter": {
    "logic": "And",
    "conditions": [
      {
        "path": "name",
        "op": "Contains",
        "value": "server"
      }
    ]
  },
  "sort": [
    {
      "path": "createdAt",
      "desc": true
    }
  ],
  "limit": 20
}
'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "objectType": "<string>",
      "type": "<string>",
      "iconId": "<string>",
      "sourceType": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "status": "<string>",
      "isManually": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdByDisplayName": "<string>",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modifiedByDisplayName": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedByDisplayName": "<string>",
      "expands": {}
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true,
  "incompleteExpands": {}
}

{
  "type": "urn:ds365:error:unknown-path",
  "title": "Unknown field path",
  "status": 400,
  "detail": "Field 'hostname' is not configured for source 'objects'",
  "instance": "/api/v1/assets/query",
  "errorCode": "UNKNOWN_PATH",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "UNKNOWN_PATH",
      "path": "filter",
      "data": {
        "field": "hostname",
        "source": "objects",
        "origin": "filter"
      }
    }
  ]
}

{
  "type": "urn:ds365:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Missing required scopes: api_read",
  "instance": "/api/v1/assets",
  "errorCode": "FORBIDDEN",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "FORBIDDEN",
      "data": {
        "missingScopes": [
          "api_read"
        ]
      }
    }
  ]
}

{
  "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-12-01T00:00:00.0000000+00:00.",
  "instance": "/api/v1/assets",
  "errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "REST_REQUEST_QUOTA_EXCEEDED",
      "data": {
        "requestsLimit": 10000,
        "requestsUsed": 10000,
        "quotaResetAt": "2026-12-01T00:00:00+00:00"
      }
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

The API key of the subscription. Each operation names the scope it needs in x-pat-scopes: api_read (in the interface Read) or api_write (Read and Write). The key is created under Administration › Integrations › API Keys.

Body

application/json

select

string[]

The fields to return. Without it, all fields of the asset.

filter

Filter group · object

Show child attributes

sort

Sort field · object[]

The sort order. Without it, by id. The id is always the last sort key unless it is sorted explicitly.

Show child attributes

limit

integer<int32>

default:50

The page size.

expands

Expand definition · object[]

Related data to read with each asset. An unknown name is skipped without an error.

Show child attributes

Response

A page of assets.

items

(Asset · object | Expand row · object)[]

required

The assets, or for an expand cursor the rows of the expand.

An asset. With select on POST /assets/query an item holds only the selected properties and the lifted expands under their names (object_data as an object, the others as a list).

Asset
Expand row

Show child attributes

nextCursor

string | null

Present when more items exist. Valid for one hour, for the same user and subscription.

hasMore

boolean

True when more items exist.

incompleteExpands

object | null

Expands that hold more rows than their limit, keyed name:parentId.

Show child attributes