Add a task

curl --request POST \
  --url https://api.scoutworks.app/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'

import requests

url = "https://api.scoutworks.app/api/v1/tasks"

payload = {
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({boardId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', title: '<string>'})
};

fetch('https://api.scoutworks.app/api/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "title": "<string>",
    "priority": "low",
    "dueDate": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "labels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "title": "<string>",
    "priority": "low",
    "dueDate": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "labels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

Tasks

Add a task

Adds a task to a board, in the column you name or the board’s first. A key reaches every board in its group, restricted boards and the trustee duties board included. A change is recorded as made by the admin who created the key, and Scoutworks marks the task with the key’s name. On the trustee duties board every task is a trustee duty: adding one needs a dueDate, and creates the duty with it. Writes count towards the key’s usual limit and a second one of 30 changes a minute. A group whose subscription has lapsed answers 402.

Send an Idempotency-Key header (any printable text up to 255 characters, unique per task) so a retry after a timeout cannot add the task twice. For 24 hours, the same key with the same body answers 200 with the first task and an Idempotent-Replayed: true header; with a different body it answers 400; while the first request is still running it answers 409.

POST

tasks

Add a task

curl --request POST \
  --url https://api.scoutworks.app/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'

import requests

url = "https://api.scoutworks.app/api/v1/tasks"

payload = {
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({boardId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', title: '<string>'})
};

fetch('https://api.scoutworks.app/api/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "title": "<string>",
    "priority": "low",
    "dueDate": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "labels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "title": "<string>",
    "priority": "low",
    "dueDate": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "labels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "<string>"
  },
  "errorRef": "<string>",
  "retryAfter": 0
}

Authorizations

Authorization

string

header

required

A group API key, sent as Authorization: Bearer sw_live_…. Keys from staging and the demo start sw_test_ instead. A group admin creates keys in Settings → Integrations → API keys.

Body

application/json

A field not listed here is refused with a 400.

boardId

string<uuid>

required

A board from GET /task-boards.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

title

string

required

Required string length: 1 - 255

columnId

string<uuid>

A column on that board. Leave it out to add the task to the board’s first column.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

description

string | null

Notes, up to 5,000 characters. Shown in Scoutworks. Free text never leaves through the API, so it is not returned.

Maximum string length: 5000

priority

enum<string>

Defaults to medium.

Available options:

low,

medium,

high,

urgent

dueDate

string<date-time> | null

When it is due, ISO 8601. Null for no due date.

labelIds

string<uuid>[]

Labels from the task’s board (GET /task-boards). Replaces the task’s labels; an id not on the board is refused.

Maximum array length: 20

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

{key}

any

Response

The task an earlier request with the same Idempotency-Key added.

data

object

required

Show child attributes

Overview

Your key

Members

Sections

Events

Badges

Waiting list

Tasks

Districts and above

Add a task

Authorizations

Body

Response