StaffCircle API
  1. Help Center
  2. StaffCircle API

5.10 Tasks

Task Template

{

    "id": <int> ,

    "title": <string>,

    "description": <string>,

    "priority": <string>",

    "frequency": <string – present only if task recurrs>,

    "groupId": <int>,

    "groupTitle":<string – title linked to groupId>,

    "isAdhoc":<bool – true if not recurring>,

       "createdByPersonId": <int>

    "assignedPersonId": <int>,

    "managerPersonId": <int>,

       "completedByPersonId": <int – 0 if not completed>,

    "dueDate": <string ISO 8601 Date>,

    "createdOn": <string ISO 8601 Date>,

    "form": { <only present if linked to a worksheet>

      "id": <int>,

      "title": <string>

    },

    "contentSettings": <contentSettings see 8.0>,

       "notificationSettings" : <notificationSettings see 8.0>,

  }

Json Schema (for use with MS Power Automate)

{
    "type": "object",
    "properties": {
        "subjectType": {
            "type": "string"
        },
        "changeType": {
            "type": "string"
        },
        "subjectFrontEndUrl": {
            "type": "string"
        },
        "timeStamp": {
            "type": "string"
        },
        "data": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "title": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "priority": {
                    "type": "string"
                },
                "groupId": {
                    "type": "integer"
                },
                "groupTitle": {
                    "type": "string"
                },
                "progress": {
                    "type": "integer"
                },
                "isAdhoc": {
                    "type": "boolean"
                },
                "createdByPerson": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "person": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "manager": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "startedByPersonId": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "modifiedByPerson": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "completedByPerson": {
                    "type": "object",
                    "properties": {
                        "PersonId": {
                            "type": "integer"
                        },
                        "FirstName": {
                            "type": "string"
                        },
                        "FamilyName": {
                            "type": "string"
                        },
                        "Email": {
                            "type": "string"
                        }
                    }
                },
                "formData": {
                    "type": "object",
                    "properties": {
                        "Location": {
                            "type": "object",
                            "properties": {
                                "lat": {
                                    "type": [
                                        "number",
                                        "null"
                                    ]
                                },
                                "long": {
                                    "type": [
                                        "number",
                                        "null"
                                    ]
                                }
                            }
                        },
                        "Fields": {
                            "type": [
                                "array",
                                "null"
                            ],
                            "items": {
                                "type": "object",
                                "properties": {
                                    "Field": {
                                        "type": "object",
                                        "properties": {
                                            "Id": {
                                                "type": "integer"
                                            },
                                            "Title": {
                                                "type": "string"
                                            },
                                            "FieldTypeId": {
                                                "type": "integer"
                                            },
                                            "FieldType": {
                                                "type": "string"
                                            }
                                        }
                                    },
                                    "Value": {
                                        "type": [
                                            "integer",
                                            "string",
                                            "object",
                                            "null"
                                        ],
                                        "properties": {
                                            "type": {
                                                "type": [
                                                    "string",
                                                    "null"
                                                ]
                                            },
                                            "src": {
                                                "type": [
                                                    "string",
                                                    "null"
                                                ]
                                            },
                                            "name": {
                                                "type": [
                                                    "string",
                                                    "null"
                                                ]
                                            }
                                        }
                                    },
                                    "Location": {
                                        "type": [
                                            "object",
                                            "null"
                                        ],
                                        "properties": {
                                            "lat": {
                                                "type": [
                                                    "number",
                                                    "null"
                                                ]
                                            },
                                            "long": {
                                                "type": [
                                                    "number",
                                                    "null"
                                                ]
                                            }
                                        }
                                    }
                                },
                                "required": [
                                    "Field",
                                    "Value"
                                ]
                            }
                        }
                    }
                },
                "completedOn": {
                    "type": "string"
                },
                "dueDate": {
                    "type": "string"
                },
                "lastModified": {
                    "type": "string"
                },
                "createdOn": {
                    "type": "string"
                },
                "form": {
                    "type": "object",
                    "properties": {
                        "id": {
                            "type": "integer"
                        },
                        "title": {
                            "type": "string"
                        }
                    }
                },
                "notificationSettings": {
                    "type": "object",
                    "properties": {
                        "push": {
                            "type": "boolean"
                        },
                        "sms": {
                            "type": "boolean"
                        },
                        "email": {
                            "type": "boolean"
                        },
                        "microsoftTeams": {
                            "type": "boolean"
                        },
                        "inApp": {
                            "type": "boolean"
                        }
                    }
                },
                "contentSettings": {
                    "type": "object",
                    "properties": {
                        "allowLikes": {
                            "type": "boolean"
                        },
                        "allowComments": {
                            "type": "boolean"
                        },
                        "allowImagesInComments": {
                            "type": "boolean"
                        },
                        "allowDocuments": {
                            "type": "boolean"
                        }
                    }
                },
                "isDeleted": {
                    "type": "boolean"
                }
            }
        },
        "differences": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "path": {
                        "type": "string"
                    },
                    "oldValue": {
                        "type": "string"
                    },
                    "newValue": {
                        "type": "string"
                    }
                },
                "required": [
                    "path",
                    "oldValue",
                    "newValue"
                ]
            }
        }
    }
}