Fetch Project Assignment Checkin Questionnaire Data

GET

/eor/contracts/:contract_id/project-assignment/checkin

GET

/rest/eor/contracts/:contract_id/project-assignment/checkin

curl -G https://api.letsdeel.com/rest/eor/contracts/m623fez/project-assignment/checkin \
     -H "Authorization: Bearer <token>" \
     -d version=e374540fc9a92390f9a1

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "sections": [
      {
        "title": "Section Title",
        "questions": [
          {
            "key": "questionExampleId",
            "type": "Dropdown",
            "title": "Please  confirm, that you have read through the Employment Compliance Notice above",
            "options": [
              {
                "title": "Yes",
                "value": "Yes"
              },
              {
                "title": "No",
                "value": "No"
              }
            ],
            "is_required": true,
            "default_value": 40,
            "is_only_digits": false
          }
        ],
        "sections": [
          {
            "questions": [
              {
                "is_required": true,
                "key": "questionKey",
                "options": [
                  {
                    "title": "Yes, I confirm",
                    "value": "Yes, I confirm"
                  }
                ],
                "title": "Question Title",
                "type": "SingleSelection"
              }
            ],
            "subtitle": "Section Subtitle",
            "title": "Section Title"
          }
        ]
      }
    ],
    "created_at": "2025-02-14T12:34:56.000Z",
    "updated_at": "2025-02-15T09:12:34.000Z"
  }
}

Returns the checkin questionnaire for a project assignment, including all sections and questions required for completion. The optional version parameter ensures the fetched questionnaire matches an expected version before it is rendered or submitted.

Token scopes: contracts:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

The unique identifier of the contract.

Query parameters

versionstringOptional=20 characters

This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned.

Response

Successful response containing form configuration data.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error