API Docs v1

Authentication

Using OneDeck's API requires API Key.
To get your API Key and Account Name, you must have an active account.

Go to Settings > General > Account

OneDeck's API uses token-based authentication, allowing users to authenticate API requests by inputting their tokens into the HTTP authorization token header.

Example:
auth-token : ACCOUNT_TOKEN
All API requests must be authenticated and made through HTTPS.

URL Access

API endpoint format
https://{accountName}.onedeck.com/api/v1{endpoint}

Boards

Get Boards

Endpoint
GET/boards
Request Header
Content-Type : application/json
auth-token : {apikey} required
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f059",
      "name": "Foo"
   }
]

Fields

Get Fields

Endpoint
GET/boards/{boardId}/fields
Request Header
Content-Type : application/json
auth-token : {apikey} required
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "name": "Status",
      "type": 3,
      "boardId": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "settings": {
         "options": [
            {
               "id": 1,
               "color": "orangeWeb",
               "label": "No answer",
               "value": 1
            }
         ]
      }
   }
]

Records

Get Record

Endpoint
GET/boards/{boardId}/records/{recordId}
Request Header
Content-Type : application/json
auth-token : {apikey} required
Response Data
{
  "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
  "name": "Foo",
  "userCreated": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
  "createDate": 1682403747944,
  "rowOrder": "0|i0000n:",
  "isCollapsed": false,
  "converted": false,
  "lastUserModified": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
  "commentsCount": 3,
  "attachmentsCount": 5,
  "lastModified": 1682403747944
}

Get Records

Endpoint
GET/boards/{boardId}/records?filters={Search Params}
Request Header
Content-Type : application/json
auth-token : {apikey} required
Search Params
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "value": ["Foo","Bar"]
   },
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f030",
      "value": ["Foo"]
   }
]
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "name": "Foo",
      "userCreated": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "createDate": 1682403747944,
      "rowOrder": "0|i0000n:",
      "isCollapsed": false,
      "converted": false,
      "lastUserModified": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "commentsCount": 3,
      "attachmentsCount": 5,
      "lastModified": 1682403747944
   }
]

Create Record

Endpoint
POST/boards/{boardId}/records
Request Header
Content-Type : application/json
auth-token : {apikey} required
Request Data
{
   "name": "Foo",
   "fields": [
      {
         "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
         "value": "Foo"
      }
   ]
}
Response Data
{
   "success": true,
   "newRecordId": "1ff5d564-2ea6-4053-8c20-fac2ef32f029"
}

Update Record

Endpoint
PUT/boards/{boardId}/records/{recordId}
Request Header
Content-Type : application/json
auth-token : {apikey} required
Request Data
[
   {
      "fieldId": "name",
      "value": "Foo"
   },
   {
      "fieldId": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "value": "Foo"
   }
]
Response Data
{
   "success": true
}

Documents

Get Document

Endpoint
GET/documents/{documentId}
Request Header
Content-Type : application/json
auth-token : {apikey} required
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "documentType": "Work Order",
      "serialNumber": "03-001763",
      "issueDate": "2024-02-21"
   }
]

Get Documents

Endpoint
GET/documents?filters={Search Params}
Request Header
Content-Type : application/json
auth-token : {apikey} required
Search Params
[
   {
      "id": "type",
      "value": ["Foo","Bar"]
   },
   {
      "id": "recipientName",
      "value": ["Foo","Bar"]
   },
   {
      "id": "recipientId",
      "value": ["1ff5d564-2ea6-4053-8c20-fac2ef32f029","1ff5d564-2ea6-4053-8c20-fac2ef32f030"]
   },
   {
      "id": "issueDate",
      "value": [377301612345,377301654321]
   },
   {
      "id": "publishedDate",
      "value": [377301612345,377301654321]
   },
   {
      "id": "createDate",
      "value": [377301612345,377301654321]
   },
   {
      "id": "serialNumber",
      "value": ["01/123456", "03/123456"]
   },
   {
      "id": "amount",
      "value": ["5000.50","10000"]
   }
]
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "documentType": "Work Order",
      "serialNumber": "03-001763",
      "issueDate": "2024-02-21"
   }
]

Users

Get Users

Endpoint
GET/users
Request Header
Content-Type : application/json
auth-token : {apikey} required
Response Data
[
   {
      "id": "1ff5d564-2ea6-4053-8c20-fac2ef32f029",
      "firstName": "John",
      "lastName": "James",
      "email": "[email protected]",
      "image": "/images/img.png",
      "createDate": "2024-02-21",
      "status": "active"
   }
]