List Decks
GEThttps://app.infodeck.io/api/organizations/:organizationId/decks
List Decks
Request
Path Parameters
organizationId stringrequired
The ID of organization.
Query Parameters
maxResults number
Possible values: >= 10
and <= 100
The maximum number of results to return.
nextToken string
To retrieve the next set of results.
Responses
- 200
- 401
- 403
- 422
- application/json
- Schema
- Example (from schema)
- Example
Schema
data object[]required
{
"data": [
{
"title": "string",
"description": "string",
"weight": "string",
"widgets": [
{
"id": "string",
"configuration": {
"assetId": "string",
"modeKey": "string"
},
"description": "string",
"gridLayout": {
"h": 0,
"i": "string",
"w": 0,
"x": 0,
"y": 0
},
"title": "string",
"type": "string"
}
],
"autoRefreshInterval": "string",
"createdAtDateString": "string",
"createdAt": 0,
"updatedAtDateString": "string",
"updatedAt": 0
}
]
}
{
"data": [
{
"title": "IDT-Deck",
"description": "IDT-Deck-Description",
"weight": "1",
"widgets": [
{
"id": "1710000000000",
"configuration": {
"assetId": "a-assetId",
"modeKey": "default"
},
"description": "Display a device status",
"gridLayout": {
"h": 15,
"i": 1700000000000,
"w": 6,
"x": 6,
"y": 0
},
"title": "Data Combination",
"type": "UtdDc"
}
],
"autoRefreshInterval": 0,
"createdAtDateString": "2024-01-01T00:00:00.000Z",
"createdAt": 1704067200000,
"updatedAtDateString": "2024-01-31T00:00:00.000Z",
"updatedAt": 1706659200000
}
]
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Unauthenticated",
"message": "Authentication is required and has failed or has not yet been provided."
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Forbidden",
"message": "Access to the requested resource is forbidden."
}
The input data has invalid.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The input data has invalid.
message stringrequired
The input data has invalid message.
{
"error": "string",
"message": "string"
}
{
"error": "ValidationError",
"message": "Input data validation failed."
}
Authorization: http
name: usertype: httpscheme: bearerbearerFormat: JWTdescription: Get your API token via POST /authentications/tokens
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://app.infodeck.io/api/organizations/:organizationId/decks' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear