Skip to main content
GET
/
plans
/
v1
/
rs
/
{planId}
Get plan with extended data
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/plans/v1/rs/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Main Plan",
    "document": {
      "id": 1,
      "presignedUrl": "https://example.com/presigned-url"
    },
    "presignedUrl": "https://example.com/presigned-url",
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "updatableFields": {
      "name": true,
      "documentId": true,
      "siteId": true,
      "code": true
    },
    "site": {
      "id": 1,
      "name": "Main site",
      "archivedAt": "2024-12-10T10:00:00.000Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
planId
integer
required

Unique identifier of the plan.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "document": Add the presigned URL for the document

  • "actions-info": Give information about actions that can be done on the plan

  • "updatable-fields": Get information about the field that can be updated

  • "site": Get information about site linked to the plan

Available options:
document,
actions-info,
updatable-fields,
site

Response

200 - application/json

Plan retrieved successfully

​
data
object
required