Get Task based on id

GET /cs-close-api/tasks/{id}

Get task details based on provided identifier in path parameters.

Path parameters

  • id integer Required

    The identifier of the task to fetch details.

Query parameters

  • include string

    We can define include parameter as CHILDREN for adding children details while fetching the task.

    Value is CHILDREN.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • logSid integer
    • name string
    • number string
    • wasCompletedLate boolean
    • currentAction string
    • period object
      Hide period attributes Show period attributes object
      • id integer
      • name string
      • statusId integer
      • year string
      • startDate string(date-time)
    • taskType object
      Hide taskType attributes Show taskType attributes object
      • id integer
      • systemValueGroupId integer
      • name string
      • shortName string
      • exportValue string
      • order integer
      • status string

        Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.

    • closeTaskDefinition object
      Hide closeTaskDefinition attributes Show closeTaskDefinition attributes object
      • id integer
      • parentId integer
      • name string
      • number string
      • description string
      • frequencyId integer
      • frequencyName string
      • status string

        Values are ACTIVE, INACTIVE, or DISABLED.

      • type string

        Values are ENTITY, CLOSE_TASK, or RECON_TASK.

      • entityId integer
      • entityName string
      • collaboration boolean
      • critical boolean
      • closePackage boolean
      • taskTypeId integer
      • taskTypeName string
      • attachmentRequired boolean
      • userDefinedFields array[object]
        Hide userDefinedFields attributes Show userDefinedFields attributes object
        • id integer
        • udfDefinitionId integer
        • value string
    • entityDefinitionId integer
    • entityName string
    • snapshotId integer
    • snapshotParentId integer
    • status object
      Hide status attributes Show status attributes object
      • id string
      • name string
    • dueDate string(date-time)
    • dateCompleted string(date-time)
    • inboxReceiverDto object
      Hide inboxReceiverDto attributes Show inboxReceiverDto attributes object
      • name string
      • type string
      • email string
      • queueId string
      • userName string
    • performer object
      Hide performer attributes Show performer attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • performerDueDate string(date-time)
    • reviewer object
      Hide reviewer attributes Show reviewer attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • reviewerDueDate string(date-time)
    • approver object
      Hide approver attributes Show approver attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • approverDueDate string(date-time)
    • late boolean
GET /cs-close-api/tasks/{id}
curl \
 --request GET 'https://customer.trintech.com/cs-close-api/tasks/{id}'
Response examples (200)
{
  "id": 42,
  "logSid": 42,
  "name": "string",
  "number": "string",
  "wasCompletedLate": true,
  "currentAction": "string",
  "period": {
    "id": 42,
    "name": "string",
    "statusId": 42,
    "year": "string",
    "startDate": "2025-05-04T09:42:00Z"
  },
  "taskType": {
    "id": 42,
    "systemValueGroupId": 42,
    "name": "string",
    "shortName": "string",
    "exportValue": "string",
    "order": 42,
    "status": "ACTIVE"
  },
  "closeTaskDefinition": {
    "id": 42,
    "parentId": 42,
    "name": "string",
    "number": "string",
    "description": "string",
    "frequencyId": 42,
    "frequencyName": "string",
    "status": "ACTIVE",
    "type": "ENTITY",
    "entityId": 42,
    "entityName": "string",
    "collaboration": true,
    "critical": true,
    "closePackage": true,
    "taskTypeId": 42,
    "taskTypeName": "string",
    "attachmentRequired": true,
    "userDefinedFields": [
      {
        "id": 42,
        "udfDefinitionId": 42,
        "value": "string"
      }
    ]
  },
  "entityDefinitionId": 42,
  "entityName": "string",
  "snapshotId": 42,
  "snapshotParentId": 42,
  "status": {
    "id": "string",
    "name": "string"
  },
  "dueDate": "2025-05-04T09:42:00Z",
  "dateCompleted": "2025-05-04T09:42:00Z",
  "inboxReceiverDto": {
    "name": "string",
    "type": "string",
    "email": "string",
    "queueId": "string",
    "userName": "string"
  },
  "performer": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "performerDueDate": "2025-05-04T09:42:00Z",
  "reviewer": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "reviewerDueDate": "2025-05-04T09:42:00Z",
  "approver": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "approverDueDate": "2025-05-04T09:42:00Z",
  "late": true
}