Deel: Update GP worker additional information

← worker_information operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.workerinformation_getgpworkeradditionalinformation

Provider route: PATCH /gp/workers/contracts/{contract_id}/additional-information. Alter supplies the connection’s credentials and routing.

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["workerInformation"]["getGpworkerAdditionalInformation"]>[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.workerInformation.getGpworkerAdditionalInformation(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.worker_information.get_gpworker_additional_information(arguments)
        result = await call.wait()
        return result.body_json()

Input

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.include_completion_status	boolean	Optional
body	object	Optional
body.data	object	Required within parent	Additional keys: see wildcard field
body.data.*	Model	Additional keys	Expand Add GP Workers Additional Information — request body — body data value
body.effective_dates	object	Optional	Per-field effective date (YYYY-MM-DD), keyed like `data`. Only allowed for effective-dated fields, and required whenever such a field is set to a new value (unchanged values and clears need no date). Past dates apply immediately as corrections, future dates are scheduled. Additional keys: see wildcard field
body.effective_dates.*	string	Additional keys	Format: date Pattern: ^\d{4}-\d{2}-\d{2}$

Referenced models: Add GP Workers Additional Information — request body — body data value

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 Update GP worker additional information — 200 response body

Referenced models: Update GP worker additional information — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.workerinformation_getgpworkeradditionalinformation. Catalog operation: workerinformation_getgpworkeradditionalinformation. 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: ["people:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source