List assets

Time	Status	User Agent
Retrieving recent requests…

Retrieve a paginated list of assets (sites) that the authenticated user has access to.

Endpoint

GET /2.0/assets

Query Parameters

Pagination & Sorting

Parameter	Type	Default	Description
`limit`	number	`100`	Number of results per page
`page`	number	`1`	Page number (1-based)
`sort`	string	-	Sort field and direction. Format: `field:asc` or `field:desc` (e.g. `siteName:asc`)

Filters

Any field listed in the Asset object can be used as a query parameter to filter results. Only fields returned in the API response can be used for filtering.

Date range filters: Date fields support range operators using dot notation:

field.gte - Greater than or equal to
field.lte - Less than or equal to
field.gt - Greater than
field.lt - Less than

Example: ownedSince.gte=2020-01-01&ownedSince.lte=2024-12-31

Common filters:

Parameter	Type	Description
`siteName`	string	Filter by site name
`siteCode`	string	Filter by site code
`assetType`	string	Filter by asset type (e.g. `Office`, `Retail`, `Industrial`)
`status`	string	Filter by status: `active` or `inactive`
`tenure`	string	Filter by tenure: `freehold` or `leasehold`
`occupationStatus`	string	Filter by occupation status: `occupied`, `vacant`, `other`, `n/a`
`entityId`	string	Filter by entity ID

Response

{
  "total": 150,
  "limit": 100,
  "skip": 0,
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "siteName": "Headquarters",
      "siteCode": "HQ-001",
      "address": {
        "streetAddress": "123 Main Street",
        "locality": "London",
        "region": "Greater London",
        "postCode": "EC1A 1BB",
        "countryCode": "gb",
        "latitude": "51.5074",
        "longitude": "-0.1278"
      },
      "assetType": "Office",
      "floorArea": 5000,
      "floorAreaUnit": "metric",
      "noOfFloors": 3,
      "status": "active",
      "tenure": "leasehold",
      "occupationStatus": "occupied",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "updatedAt": "2024-06-20T14:15:00.000Z"
    }
  ]
}

Example Request

curl -X GET "https://api.etainabl.com/2.0/assets?status=active&assetType=Office&limit=50&page=1&sort=siteName:asc" \
  -H "x-api-key: YOUR_API_KEY"

Scope Required

read:assets