---
title: "Get existing framework agreement(s)"
method: GET
path: "/public/onboarding/v1/get-framework-agreement"
tags: ["Onboarding flow"]
---

# Get existing framework agreement(s)

`GET /public/onboarding/v1/get-framework-agreement`

Get existing signed and unsigned framework agreement (if any) for the given worker.

## Query parameters

- `workerId` string, uuid, required

## Response `200`

Successfully created the agreement

- FrameworkAgreementGetResponseV1 — If there is a signed agreement, `unsignedAgreement` is `null`. If there is no signed agreement, but there is an unsigned agreement, `signedAgreement` is `null`. If neither exists, both are `null`.
  - `signedAgreement` FrameworkAgreementSignedEventV1 — Request body for the webhook that is called once a worker has signed the framework agreement.
    - `documentId` string, uuid — The id of the document containing the signed framework agreement. The document can be retrieved using the /worker-document endpoint.
  - `unsignedAgreement` FrameworkAgreementCreationResponseV1
    - `signingUrl` string, uri — A URL to the web UI (Stiply) that shows the agreement to the worker and allows them to e-sign it.
    - `signingUrlExpirationTimestamp` string, date-time — The timestamp (UTC) at which the signing URL will expire. When browsing to the URL after this timestamp, the web UI (Stiply) will show an error page.

## Other responses

- `400` — The request could not be processed. This could be due to a number of reasons: * The request does not have all required data. * Data in the request is invalid. * Data in the request is inconsistent. * The operation is not allowed given the current state of the data.
- `401` — The request did not contain credentials identifying the caller, or the provided credentials were invalid.
- `403` — The data that the request referred to is inaccessible to the caller.

---

[API](https://skmtc.net/maqqie/apis/maqqie-platform-public-api.md) · [All operations](https://skmtc.net/maqqie/apis/maqqie-platform-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/maqqie/maqqie-platform-public-api/versions/5cb82e369b70/schema)