GET Task (Search)

TABLE OF CONTENTS

Parameters
Example

Additional Info

API Explorer

This request method allows you to find all tasks matching the given criteria. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/task/search?format=xml/json

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The GET verb allows you to find all tasks matching the given criteria. The required and optional parameters for a GET(Search) call to the Task API are outlined below.

Name	Type	Description	Required
CompanyId	Integer	Your unique Company Id is found on the Organisation Setup page of the secure website.	✓
IntegrationKey	String	Your unique Integration Key is found on the Organisation Setup page of the secure website.	✓
UserEmail	String	User email to find Tasks for.
UserExternalId	String	User external ID to find Tasks for.
Status	String	Find Tasks in the given status. Defaults to retrieve all if not specified.
TemplateId	String	Find Tasks created from the given Task Template identifier.
FromDate	Date	Find Tasks updated on or since the given UTC date/time in ISO-8601 format.
ToDate	Date	Find Tasks updated up to and including the given UTC date/time in ISO-8601 format.
Name	String	Find Tasks with names that contain the provided text.
RetrieveEntries	Boolean	Include form entries on 'Fill Out Form' activities if any exist
MediaAsUrl	Boolean	Media field answers are returned as full file download URLs when including form entries instead of just the file name. True by default.
AnswerFormat	String	Specify which format to use for answers when retrieving entries is true.
EntryFields	String	Optionally restrict returned Form entry answer values to the given comma-separated list of field data names. ONLY SUPPORTED WITH 'FLAT' ANSWER FORMAT.
PageNo	Integer	The page number from which to start reading results (0 based).
PageSize	Integer	The page size (number of rows) to return. The maximum allowable value is 250.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

https://secure.formsonfire.com:443/api/v2/task/search?DateOrder=Ascending&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXX

Request Body

{
  "Tasks": [
    {
      "Id": "dd3XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "UserId": "c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "UserEmail": "cXXXXXXXXXXXX@XXXXXXXXXXXX.com",
      "UserExternalId": "test_user_extid",
      "Name": "Test task",
      "Icon": "Flag",
      "Status": "InProgress",
      "CompleteBy": "2021-04-02T22:27:00.0000000Z",
      "StartBy": "2021-04-02T21:27:00.0000000Z",
      "IsAllDay": false,
      "CompleteAtText": "",
      "AdditionalInfo": "This is a test.",
      "DisableNotes": false,
      "UserCanReject": false,
      "RestrictToGroup": "00000000000000000000000000000000",
      "UserCanReassign": false,
      "ReassignType": "Any",
      "Activities": [
        {
          "FormId": "84cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "EntryId": "b19XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "ActivityType": "FillOutForm",
          "ActivityId": "221XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        {
          "FormId": "088XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "EntryId": "ec9XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "ActivityType": "FillOutForm",
          "ActivityId": "87fbXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        {
          "Instruction": "Please make sure you bring the keys back.",
          "ActivityType": "Instruction",
          "ActivityId": "f62XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        }
      ],
      "Files": [],
      "History": [
        {
          "EventDate": "2021-04-01T14:28:00.7670000Z",
          "Status": "Draft"
        },
        {
          "EventDate": "2021-04-01T14:28:31.4800000Z",
          "Status": "Sent"
        },
        {
          "EventDate": "2021-04-01T14:28:49.1230000Z",
          "Status": "InProgress"
        }
      ],
      "StartTime": "2021-04-01T14:28:48.5400000Z",
      "CompleteTime": "1990-01-01T00:00:01.0000000Z",
      "CompanyId": 6XXXX
    }

English

Parameters

Example