Skip to main content
GET
/
projects
/
v1
/
ad
/
{projectId}
Get project
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/projects/v1/ad/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Renovation Bat A",
    "object": "Full renovation of building A",
    "scheduledAt": "2025-06-01T00:00:00.000Z",
    "folderId": 2,
    "deletedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "folder": {
      "id": 1,
      "name": "Dossier Chantiers 2025",
      "createdAt": "2024-01-15T08:45:00.000Z"
    },
    "updatableFields": {
      "name": true,
      "object": true,
      "scheduledAt": true,
      "assignedUserIds": true,
      "folderId": true,
      "deletedAt": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    }
  },
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

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"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "folder": Obtain the folder in which the profile is involved

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

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

Available options:
folder,
updatable-fields,
actions-info

Response

200 - application/json

List of projects

​
data
object
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.