You can retrieve information on individual plan items using the AchieveIt REST API. The data is returned as a JSON object and includes the current values of all fields on each plan item in the plan.

Request Specification

Endpoint URL

Make an HTTP GET request to the following endpoint:

https://api.achieveit.com/exports/plan-items/

Authorization Header

Include your API key as part of an authorization header. The API key must be associated with a user that has admin access to the plan you are exporting.

Authorization: API-KEY <YOUR_API_KEY>

Response

Response Codes

The API returns one of the following HTTP status codes.

Custom Fields

Plans that contain Custom Fields will also have their custom field information returned in the API response. All Custom Fields will be contained in the customFields object. The name of the property will match the Custom Field name, and the value type will match the Custom Field type.

Example Response

If successful, the response body will be a JSON object that contains the following information about the plan item.

{
 "id": "string",
 "sourceId": "string",
 "rowNumber": 0,
 "sequenceId": "string",
 "planId": "string",
 "planName": "string",
 "sourcePlanId": "string" or null,
 "sourcePlanName": "string" or null,
 "alignsTo": "string" or null,
 "alignsToId": "string" or null,
 "dependentOn": "string" or null,
 "dependentOnId": "string" or null,
 "levelId": "string",
 "level": "string",
 "name": "string",
 "indentedName": "string",
 "description": "string",
 "status": 0,
 "statusName": "string",
 "start": "string" or null,
 "due": "string" or null,
 "created": "string",
 "hasMetric": true,
 "hasAdvancedMetric": true,
 "units": 0 or null,
 "detail": 0 or null,
 "baseline": "0",
 "target": "0",
 "currentValue": "0",
 "advancedMetricGoals": [
   {
     "goalId": "string",
     "goalName": "string",
     "goalColor": "string",
     "metricBucketValue": 0.0,
     "sortOrder": 0
   }
 ],
 "lastUpdated": "string",
 "assignedToId": "string" or null,
 "assignedToFullName": "string" or null,
 "assignedById": "string" or null,
 "assignedByFullName": "string" or null,
 "members": [
   {
     "id": "string",
     "name": "string",
     "type": "User" or "Team"
   }
 ],
 "admins": [
   {
     "id": "string",
     "name": "string",
     "type": "User" or "Team"
   }
 ],
 "updateFrequency": "NotRequired" or "Daily" or "Weekly" or "Biweekly" or "Monthly" or "Quarterly",
 "updateFrequencyDescription": same as above,
 "isPastDue": true or false,
 "lateUpdates": integer,
 "pendingUpdates": integer,
 "updates": integer,
 "lastCommentId": "string" or null,
 "lastComment": "string" or null,
 "lastUpdateCommentId": "string" or null,
 "lastUpdateComment": "string" or null,
 "files": integer,
 "checklists": [
   {
     "id": "string",
     "name": "string",
     "sortIndex": 0,
     "items": [
       {
         "id": "string",
         "name": "string",
         "sortIndex": 0,
         "doneOn": "string" or null
       }
     ]
   }
 ],
 "tags": [
   {
     "id": "string",
     "organizationId": "string",
     "name": "string"
   }
 ],
 "isOrphan": false,
 "customFields": {
   "customFieldName": customFieldValue or null
 }
}