Deel: Fetch Project Assignment Checkin Questionnaire Data
Deel eorProjectAssignment.getProjectAssignmentCheckin: arguments, response, policy and SDK examples.
← EOR project assignment operations · Get started
Operation deel.eorprojectassignment_getprojectassignmentcheckin
Provider route: GET /eor/contracts/{contract_id}/project-assignment/checkin. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorProjectAssignment"]["getProjectAssignmentCheckin"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.eorProjectAssignment.getProjectAssignmentCheckin(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.eor_project_assignment.get_project_assignment_checkin(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.version | string | Optional | Maximum length: 20 Minimum length: 20 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body
Schemas
Section titled “Schemas”Fetch Project Assignment Checkin Questionnaire Data — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp indicating when the resource was created (ISO 8601). Format: date-time |
id | string | Required within parent | Unique identifier of the resource Format: uuid |
sections | array | Required within parent | Sections of questions |
sections[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item |
updated_at | string | Required within parent | Timestamp indicating when the resource was last updated (ISO 8601). Format: date-time |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
questions | array | Required within parent | List of questions within the section. |
questions[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item |
subtitle | string | Optional | Additional information shown at the top of the section. |
title | string | Required within parent | Title of the section. |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default_value | Model | Optional | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value Default value to pre-fill in the form. |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions. |
is_required | boolean | Optional | Indicates if the question is required. |
key | string | Required within parent | Unique key identifier for the question. |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 1)[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 2)[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item |
title | string | Required within parent | Title of the question. |
type | string | Required within parent | Type of the question. Known values: FreeText, Paragraph, SingleSelection, MultiSelection, Address, PhoneNumber, DocumentUpload, Number, Dropdown, DatePicker, Email |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Default value to pre-fill in the form. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative |
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | string | Optional | Display text for the option. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value associated with the option. |
value (anyOf 2) | null | Alternative | Value associated with the option. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorprojectassignment_getprojectassignmentcheckin. Catalog operation: eorprojectassignment_getprojectassignmentcheckin. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read"]
Pinned headers: {"X-Version": "2026-01-01"}