MENU navbar-image

Introduction

API documentation for App.CheckLister.eu.

This documentation aims to provide all the information you need to work with our API.

Base URL

https://app.checklister.eu

Authenticating requests

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_API_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your app and clicking API tokens.

Projects

GET api/v1/api-projects

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-projects" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-projects"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-projects',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-projects'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-projects

POST api/v1/api-projects

requires authentication

Example request:
curl --request POST \
    "https://app.checklister.eu/api/v1/api-projects" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Project\",
    \"description\": \"Yahoo. My first project via API.\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-projects"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Project",
    "description": "Yahoo. My first project via API.",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.checklister.eu/api/v1/api-projects',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Project',
            'description' => 'Yahoo. My first project via API.',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-projects'
payload = {
    "name": "My Project",
    "description": "Yahoo. My first project via API.",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST api/v1/api-projects

Body Parameters

name  string  

The name of the project.

description  string optional  

The description of the project.

disabled_comments  boolean optional  

The settings for disabling comments in project.

show_in_sidebar  boolean optional  

The settings for showing project in the left sidebar.

GET api/v1/api-projects/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-projects/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-projects/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-projects/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-projects/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-projects/{id}

URL Parameters

id  integer  

The ID of the project.

PUT api/v1/api-projects/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.checklister.eu/api/v1/api-projects/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Project\",
    \"description\": \"Yahoo. My first project via API.\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-projects/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Project",
    "description": "Yahoo. My first project via API.",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://app.checklister.eu/api/v1/api-projects/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Project',
            'description' => 'Yahoo. My first project via API.',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-projects/1'
payload = {
    "name": "My Project",
    "description": "Yahoo. My first project via API.",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT api/v1/api-projects/{id}

PATCH api/v1/api-projects/{id}

URL Parameters

id  integer  

The ID of the project.

Body Parameters

name  string  

The name of the project.

description  string optional  

The description of the project.

disabled_comments  boolean optional  

The settings for disabling comments in project.

show_in_sidebar  boolean optional  

The settings for showing project in the left sidebar.

DELETE api/v1/api-projects/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.checklister.eu/api/v1/api-projects/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-projects/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://app.checklister.eu/api/v1/api-projects/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-projects/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE api/v1/api-projects/{id}

URL Parameters

id  integer  

The ID of the project.

Checklist Groups

GET api/v1/api-checklist-groups

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-checklist-groups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklist-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-checklist-groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklist-groups'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-checklist-groups

POST api/v1/api-checklist-groups

requires authentication

Example request:
curl --request POST \
    "https://app.checklister.eu/api/v1/api-checklist-groups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Checklist Group\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklist-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Checklist Group",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.checklister.eu/api/v1/api-checklist-groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Checklist Group',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklist-groups'
payload = {
    "name": "My Checklist Group",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST api/v1/api-checklist-groups

Body Parameters

name  string  

The name of the checklist group.

disabled_comments  boolean optional  

The settings for disabling comments in checklist group.

show_in_sidebar  boolean optional  

The settings for showing checklist group in the left sidebar.

GET api/v1/api-checklist-groups/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-checklist-groups/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklist-groups/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-checklist-groups/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklist-groups/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-checklist-groups/{id}

URL Parameters

id  integer  

The ID of the checklist group.

PUT api/v1/api-checklist-groups/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.checklister.eu/api/v1/api-checklist-groups/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Checklist Group\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklist-groups/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Checklist Group",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://app.checklister.eu/api/v1/api-checklist-groups/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Checklist Group',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklist-groups/1'
payload = {
    "name": "My Checklist Group",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT api/v1/api-checklist-groups/{id}

PATCH api/v1/api-checklist-groups/{id}

URL Parameters

id  integer  

The ID of the checklist group.

Body Parameters

name  string  

The name of the checklist group.

disabled_comments  boolean optional  

The settings for disabling comments in checklist group.

show_in_sidebar  boolean optional  

The settings for showing checklist group in the left sidebar.

DELETE api/v1/api-checklist-groups/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.checklister.eu/api/v1/api-checklist-groups/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklist-groups/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://app.checklister.eu/api/v1/api-checklist-groups/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklist-groups/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE api/v1/api-checklist-groups/{id}

URL Parameters

id  integer  

The ID of the checklist group.

Checklists

GET api/v1/api-checklists

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-checklists" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklists"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-checklists',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklists'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-checklists

POST api/v1/api-checklists

requires authentication

Example request:
curl --request POST \
    "https://app.checklister.eu/api/v1/api-checklists" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Checklist\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklists"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Checklist",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.checklister.eu/api/v1/api-checklists',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Checklist',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklists'
payload = {
    "name": "My Checklist",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST api/v1/api-checklists

Body Parameters

name  string  

The name of the checklist.

disabled_comments  boolean optional  

The settings for disabling comments in checklist.

show_in_sidebar  boolean optional  

The settings for showing checklist in the left sidebar.

GET api/v1/api-checklists/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-checklists/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklists/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-checklists/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklists/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-checklists/{id}

URL Parameters

id  integer  

The ID of the checklist.

PUT api/v1/api-checklists/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.checklister.eu/api/v1/api-checklists/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Checklist\",
    \"disabled_comments\": false,
    \"show_in_sidebar\": true
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklists/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Checklist",
    "disabled_comments": false,
    "show_in_sidebar": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://app.checklister.eu/api/v1/api-checklists/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Checklist',
            'disabled_comments' => false,
            'show_in_sidebar' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklists/1'
payload = {
    "name": "My Checklist",
    "disabled_comments": false,
    "show_in_sidebar": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT api/v1/api-checklists/{id}

PATCH api/v1/api-checklists/{id}

URL Parameters

id  integer  

The ID of the checklist.

Body Parameters

name  string  

The name of the checklist.

disabled_comments  boolean optional  

The settings for disabling comments in checklist.

show_in_sidebar  boolean optional  

The settings for showing checklist in the left sidebar.

DELETE api/v1/api-checklists/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.checklister.eu/api/v1/api-checklists/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-checklists/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://app.checklister.eu/api/v1/api-checklists/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-checklists/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE api/v1/api-checklists/{id}

URL Parameters

id  integer  

The ID of the checklist.

Tasks

POST api/v1/api-tasks

requires authentication

Example request:
curl --request POST \
    "https://app.checklister.eu/api/v1/api-tasks" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Task\",
    \"description\": \"Yahoo. My first task via API.\",
    \"checklist_id\": 1
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Task",
    "description": "Yahoo. My first task via API.",
    "checklist_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.checklister.eu/api/v1/api-tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Task',
            'description' => 'Yahoo. My first task via API.',
            'checklist_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-tasks'
payload = {
    "name": "My Task",
    "description": "Yahoo. My first task via API.",
    "checklist_id": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST api/v1/api-tasks

Body Parameters

name  string  

The name of the task.

description  string optional  

The description of the task.

checklist_id  integer  

The ID of the checklist.

GET api/v1/api-tasks/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.checklister.eu/api/v1/api-tasks/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-tasks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.checklister.eu/api/v1/api-tasks/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-tasks/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET api/v1/api-tasks/{id}

URL Parameters

id  integer  

The ID of the task.

PUT api/v1/api-tasks/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.checklister.eu/api/v1/api-tasks/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Task\",
    \"description\": \"Yahoo. My first task via API.\",
    \"checklist_id\": 1
}"

const url = new URL(
    "https://app.checklister.eu/api/v1/api-tasks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My Task",
    "description": "Yahoo. My first task via API.",
    "checklist_id": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://app.checklister.eu/api/v1/api-tasks/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'My Task',
            'description' => 'Yahoo. My first task via API.',
            'checklist_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-tasks/1'
payload = {
    "name": "My Task",
    "description": "Yahoo. My first task via API.",
    "checklist_id": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT api/v1/api-tasks/{id}

PATCH api/v1/api-tasks/{id}

URL Parameters

id  integer  

The ID of the task.

Body Parameters

name  string  

The name of the task.

description  string optional  

The description of the task.

checklist_id  integer  

The ID of the checklist.

DELETE api/v1/api-tasks/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.checklister.eu/api/v1/api-tasks/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.checklister.eu/api/v1/api-tasks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://app.checklister.eu/api/v1/api-tasks/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.checklister.eu/api/v1/api-tasks/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE api/v1/api-tasks/{id}

URL Parameters

id  integer  

The ID of the task.