Skip to content
NordfleetNordfleet Docs

Check availability for a date range

GET
/asset-groups/{id}/availability
curl --request GET \
  --url 'https://demo.yourapp.com/api/v1/asset-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/availability?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z' \
  --header 'Authorization: Bearer <token>'

Aggregate availability only — individual vehicles are never exposed. Requires the availability:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
from
required
string format: date-time
to
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Availability summary

Media typeapplication/json
object
data
object
assetGroupId
required
string format: uuid
from
required
string format: date-time
to
required
string format: date-time
available
required
boolean
availableCount
required
integer
totalAssets
required
integer
Examplegenerated
{
  "data": {
    "assetGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "from": "2026-04-15T12:00:00Z",
    "to": "2026-04-15T12:00:00Z",
    "available": true,
    "availableCount": 1,
    "totalAssets": 1
  }
}

400

Section titled “400”

Request validation failed (VALIDATION_ERROR)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Array<object>
object
path
string
message
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

401

Section titled “401”

Missing/invalid/revoked/expired API key (API_KEY_REQUIRED, API_KEY_INVALID, API_KEY_REVOKED, API_KEY_EXPIRED) or missing/invalid session token on the browser channel (SESSION_REQUIRED, SESSION_INVALID, SESSION_EXPIRED).

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Array<object>
object
path
string
message
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

404

Section titled “404”

Resource not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Array<object>
object
path
string
message
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

429

Section titled “429”

Rate limit exceeded (RATE_LIMITED)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Array<object>
object
path
string
message
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds until the window resets

X-RateLimit-Limit
integer
X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Unix timestamp (seconds) of the window reset