API reference
API reference
Cases
Studies of a client and the cases cut from them, each running through a Planner plan: versions, shares to a customer organisation or named people, who opened what, and lessons a person approves. Enterprise accounts only; every refusal is a not found.
25 methods
- GETList client cases/v1/cases/client-cases
- POSTCreate a client case/v1/cases/client-cases
- GETGet a client case/v1/cases/client-cases/{case_id}
- PUTSave a client case/v1/cases/client-cases/{case_id}
- POSTMark a plan item shareable/v1/cases/client-cases/{case_id}/items
- GETList who opened a client case/v1/cases/client-cases/{case_id}/opens
- POSTPublish a client case/v1/cases/client-cases/{case_id}/publish
- GETList the shares of a client case/v1/cases/client-cases/{case_id}/shares
- POSTShare a client case/v1/cases/client-cases/{case_id}/shares
- GETList client case versions/v1/cases/client-cases/{case_id}/versions
- GETGet a client case version/v1/cases/client-cases/{case_id}/versions/{version}
- GETGet the plan behind a case/v1/cases/plan
- GETList the cases shared with me/v1/cases/shared
- GETOpen a shared case/v1/cases/shared/{case_id}
- POSTExtend a share/v1/cases/shares/{share_id}/extend
- POSTRevoke a share/v1/cases/shares/{share_id}/revoke
- GETList studies/v1/cases/studies
- POSTCreate a study/v1/cases/studies
- GETGet a study/v1/cases/studies/{study_id}
- PUTSave a study/v1/cases/studies/{study_id}
- GETGet a study's lessons/v1/cases/studies/{study_id}/lessons
- POSTApprove lessons/v1/cases/studies/{study_id}/lessons/approve
- POSTDraft lessons/v1/cases/studies/{study_id}/lessons/draft
- GETList study versions/v1/cases/studies/{study_id}/versions
- GETGet a study version/v1/cases/studies/{study_id}/versions/{version}