List a client’s checklists
curl --request GET \
--url https://advisor.redbark.com/api/v1/clients/{client}/checklists \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://advisor.redbark.com/api/v1/clients/{client}/checklists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://advisor.redbark.com/api/v1/clients/{client}/checklists"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"object": "checklist",
"id": "<string>",
"client_id": "<string>",
"name": "<string>",
"template_id": "<string>",
"sent_at": "<string>",
"progress": {
"done": 123,
"total": 123,
"submitted": 123,
"open": 123
},
"complete": true,
"items": [
{
"object": "checklist_item",
"id": "<string>",
"checklist_id": "<string>",
"position": 123,
"kind": "document",
"title": "<string>",
"help": "<string>",
"required": true,
"questions": [
{
"key": "<string>",
"label": "<string>",
"type": "short",
"options": [
"<string>"
],
"fact_key": "<string>"
}
],
"prefill_from_facts": true,
"state": "todo",
"change_note": "<string>",
"submitted_at": "<string>",
"submitted_by": "<string>",
"reviewed_at": "<string>",
"reviewed_by": "<string>",
"documents": [
{
"id": "<string>",
"file_name": "<string>",
"page_count": 123,
"uploaded_at": "<string>"
}
],
"answers": [
{
"question_key": "<string>",
"label": "<string>",
"value": "<string>",
"answered_at": "<string>",
"prefilled_from_document_id": "<string>"
}
]
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"next_page_url": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Checklists
List a client’s checklists
The checklists sent to a client, oldest first, with every item: its state, the files uploaded to it, and the answers given. Items that are submitted are waiting for the firm to approve or request changes.
GET
/
clients
/
{client}
/
checklists
List a client’s checklists
curl --request GET \
--url https://advisor.redbark.com/api/v1/clients/{client}/checklists \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://advisor.redbark.com/api/v1/clients/{client}/checklists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://advisor.redbark.com/api/v1/clients/{client}/checklists"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"object": "checklist",
"id": "<string>",
"client_id": "<string>",
"name": "<string>",
"template_id": "<string>",
"sent_at": "<string>",
"progress": {
"done": 123,
"total": 123,
"submitted": 123,
"open": 123
},
"complete": true,
"items": [
{
"object": "checklist_item",
"id": "<string>",
"checklist_id": "<string>",
"position": 123,
"kind": "document",
"title": "<string>",
"help": "<string>",
"required": true,
"questions": [
{
"key": "<string>",
"label": "<string>",
"type": "short",
"options": [
"<string>"
],
"fact_key": "<string>"
}
],
"prefill_from_facts": true,
"state": "todo",
"change_note": "<string>",
"submitted_at": "<string>",
"submitted_by": "<string>",
"reviewed_at": "<string>",
"reviewed_by": "<string>",
"documents": [
{
"id": "<string>",
"file_name": "<string>",
"page_count": 123,
"uploaded_at": "<string>"
}
],
"answers": [
{
"question_key": "<string>",
"label": "<string>",
"value": "<string>",
"answered_at": "<string>",
"prefilled_from_document_id": "<string>"
}
]
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"next_page_url": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Authorizations
A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.
Path Parameters
The client id, from list_clients.
Required string length:
1 - 60Query Parameters
1 to 100. Default 25.
Required range:
1 <= x <= 100The next_cursor of the previous page.
Maximum string length:
400
