Skip to main content
GET
/
tpa
/
plan
/
get
Get TPA Plan
curl --request GET \
  --url https://api.stax.ai/tpa/plan/get \
  --cookie authToken=
{
  "success": true,
  "plan": {
    "_id": "<string>",
    "team": "<string>",
    "pensionProId": 123,
    "internalPlanId": "<string>",
    "planName": "<string>",
    "planType": "<string>",
    "endMm": 123,
    "endDd": 123,
    "active": true,
    "directory": "<string>",
    "ppLock": true,
    "search": [
      "<string>"
    ],
    "notes": [
      {
        "author": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "content": "<string>"
      }
    ],
    "lastModified": "2023-11-07T05:31:56Z",
    "assignees": [
      "<string>"
    ],
    "status": {}
  }
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Query Parameters

planId
string
required

MongoDB ObjectId

Response

200 - application/json

Plan information

success
boolean
plan
object