Skip to main content
GET
/
tpa
/
plan
/
list
List TPA Plans
curl --request GET \
  --url https://api.stax.ai/tpa/plan/list \
  --cookie authToken=
{
  "success": true,
  "plans": [
    {
      "_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

Response

200 - application/json

List of plans

success
boolean
plans
object[]