This request method allows you to find the recurring task 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/taskrecurring?format=xml/json

You may use either JSON or XML formats in your GET submission.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.

If no ContentType is specified, XML format is assumed.

Note: 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"

ADDITIONAL INFO

• API Explorer
• General Info & Status Codes

Endpoints & API Explorer

Parameters

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

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://eforms.mobileform.net:443/api/v2/taskrecurring?Id=XXXXXXXXXXX&CompanyId=X&IntegrationKey=XXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body

{
  "TaskRecurring": {
    "Name": "Recurring - MyTask111",
    "Description": "MyTask",
    "RepeatEvery": 1,
    "WeeklySelectedDays": [],
    "Occurrences": 2,
    "Id": "eb5379084bda49549955b23c0038df86",
    "UserId": "85589128040b48e591ccb1f0002ca765",
    "UserEmail": "danitest@testcompany.com",
    "UserExternalId": "Unknown",
    "TemplateId": "d8379984ea364b1686cfb23c00138de6",
    "IsAllDay": true,
    "RestrictToGroup": "00000000000000000000000000000000",
    "UserCanReassign": false,
    "Activities": [
      {
        "FormId": "8995af1ede6f4ff3999cb1f0001b2314",
        "EntryId": "37605f66c35f4cd697ecb23c0038d3c0",
        "ActivityType": "FillOutForm",
        "ActivityId": "97a32a68-8160-42c4-b8ca-b23c0038d3c0",
        "IsOptional": false
      }
    ],
    "History": [
      {
        "TaskRecurringType": "Monthly",
        "NextOccurrence": "2024-12-04T13:30:00.0000000Z",
        "Status": "NotStarted",
        "StartingOn": "2024-12-04T13:30:00.0000000Z",
        "EndingOn": "2025-01-05T13:29:00.0000000Z",
        "IsAllDay": true,
        "TotalOccurrences": 2,
        "DateModifiedUtc": "2024-12-04T03:27:04.1280000Z",
        "WeeklySelectedDays": [],
        "RepeatEvery": 1,
        "Ends": "After",
        "AppUserId": "85589128040b48e591ccb1f0002ca765"
      }
    ],
    "Schedule": [
      {
        "Start": "2024-12-04T13:30:00.0000000Z",
        "End": "2024-12-05T13:29:00.0000000Z",
        "TaskId": "43f89be0c2b94b3ca995b23c0038dfc9"
      },
      {
        "Start": "2025-01-04T13:30:00.0000000Z",
        "End": "2025-01-05T13:29:00.0000000Z",
        "TaskId": "1d6d7dfefe7f4b0c98f4b23c0038dfd4"
      }
    ],
    "CompanyId": XX
  }
}