v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

tasks

find many tasks

Find many tasks (with filtering, projection, pagination and limiting). You can use filters in the query parameters (properly URL encoded) to restrict the search results:

To restrict the search to specific values for a given field name, you can use the following syntax: filter[where][fieldName][eq]=value. Note that you can also nest the filter object to filter on multiple fields, like so: filter[where][and][0][fieldName1][eq]=value1&filter[where][and][1][fieldName2][eq]=value2. You can also use operators like gt, gte, lt, lte, ne, in, nin, etc.
To limit the number of results returned by the query, use the following syntax: filter[limit]=25&filter[skip]=25
To only return specific fields, use the projection query parameter. Usage is as follows: filter[fields][fieldName1]=true&filter[fields][fieldName2]=true.

get/api/servicetodo/tasks

Query parameters

whereParametersFilterWhere

fieldsParametersFilterFields

limitnumber

skipnumber

orderstring[]

{
  "limit": 10,
  "order": [
    "prop DESC"
  ]
}

Response

One or many task documents found. Wrapped in a JsonAPI root response with collection of documents as data.

Example response

{
  "data": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "createdAt": "2021-05-05T01:02:03.924Z",
      "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
      "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
      "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
      "lastUpdatedByAudience": "employer",
      "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
      "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
      "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
      "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
      "companyUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9",
      "title": "Read this document",
      "description": "You need to read this document before being able to work",
      "taskType": "informationSharing",
      "subType": "webhook",
      "estimatedCompletionMinutes": 90,
      "content": {
        "buttonLabel": "myBtnLabel",
        "attachments": [
          {
            "storedFileUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9",
            "filename": "handbook.pdf",
            "mimeType": "application/pdf"
          }
        ],
        "signDoc": {
          "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
          "createdAt": "2021-05-05T01:02:03.924Z",
          "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
          "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
          "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
          "lastUpdatedByAudience": "employer",
          "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
          "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
          "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
          "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
          "name": "Profile pic.png",
          "technicalName": "profile_pic.png",
          "companyUuid": "2c84a7c1-4c68-41d8-9376-2a14c60de15f"
        },
        "section2CompletionMethods": [
          {
            "methodName": "authorizedRepresentative",
            "reminder": 24,
            "customConferencing": {
              "providerDescription": "Zoom",
              "joinUrl": "https://www.my-conferencing.com/join/xyz"
            }
          }
        ],
        "triggerableType": "task",
        "companyAttributeSet": {
          "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
          "createdAt": "2021-05-05T01:02:03.924Z",
          "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
          "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
          "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
          "lastUpdatedByAudience": "employer",
          "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
          "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
          "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
          "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
          "companyUuid": "bd1663ba-1d09-4554-a21a-d7a62e9b0435",
          "label": "European companies",
          "companyAttributes": [
            {
              "companyAttributeUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
              "companyAttribute": {
                "uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
                "createdAt": "2021-05-05T01:02:03.924Z",
                "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
                "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
                "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
                "lastUpdatedByAudience": "employer",
                "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
                "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
                "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
                "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
                "label": "Attribute 1",
                "key": "attribute_1",
                "dataType": "string",
                "description": "The first attribute in my company",
                "hireUuid": "123e4567-e89b-12d3-a456-426614174232",
                "attachedToModel": "location"
              }
            }
          ]
        },
        "requirementUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9"
      }
    }
  ],
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}