--- title: "Get contracts" method: GET path: "/contracts" tags: ["Contract"] --- # Get contracts `GET /contracts` Use this endpoint to retrieve the list of contracts. ## Query parameters - `offset` integer - `limit` integer - `sort` string - `filter[canceled]` 'true' | 'false' - `filter[closed_time]` string - `filter[created_time]` string - `filter[data_field_match]` string - `filter[email]` string, email - `filter[folder_ids]` string - `filter[id]` string - `filter[lifecycle_started_time]` string - `filter[lifecycle_states]` string - `filter[participant_custom_id]` string - `filter[participant_identification_number]` string - `filter[published_time]` string - `filter[query]` string - `filter[states]` string - `filter[upcoming_time]` string - `filter[updated_time]` string - `filter[workspace_ids]` string - `filter[tag_ids]` string - `filter[template_ids]` string - `filter[playbook_ids]` string - `filter[blueprint_ids]` string ## Headers - `x-oneflow-api-token` string, required - `x-oneflow-user-email` string, email ## Response `200` Returns the list of all [contracts](contract) in the specified account. - object — A list of contracts in an account. - `_links` object — Links to related endpoints. - `comments` object - `href` string, nullable - `contracts` object - `href` string, nullable - `contract` object - `href` string, nullable - `create` object - `href` string, nullable - `data_field` object - `href` string, nullable - `data_fields` object - `href` string, nullable - `events` object - `href` string, nullable - `event` object - `href` string, nullable - `files` object - `href` string, nullable - `file` object - `href` string, nullable - `next` object - `href` string, nullable - `parties` object - `href` string, nullable - `party` object - `href` string, nullable - `previous` object - `href` string, nullable - `publish` object - `href` string, nullable - `self` object - `href` string, nullable - `template_types` object - `href` string, nullable - `template_type` object - `href` string, nullable - `template` object - `href` string, nullable - `templates` object - `href` string, nullable - `workspaces` object - `href` string, nullable - `workspace` object - `href` string, nullable - `playbooks` object - `href` string, nullable - `count` integer, required - `data` object[], required - `_links` object — Links to related endpoints. - `comments` object - `href` string, nullable - `contracts` object - `href` string, nullable - `contract` object - `href` string, nullable - `create` object - `href` string, nullable - `data_field` object - `href` string, nullable - `data_fields` object - `href` string, nullable - `events` object - `href` string, nullable - `event` object - `href` string, nullable - `files` object - `href` string, nullable - `file` object - `href` string, nullable - `next` object - `href` string, nullable - `parties` object - `href` string, nullable - `party` object - `href` string, nullable - `previous` object - `href` string, nullable - `publish` object - `href` string, nullable - `self` object - `href` string, nullable - `template_types` object - `href` string, nullable - `template_type` object - `href` string, nullable - `template` object - `href` string, nullable - `templates` object - `href` string, nullable - `workspaces` object - `href` string, nullable - `workspace` object - `href` string, nullable - `playbooks` object - `href` string, nullable - `_permissions` object, required — This attribute contains the permissions for various operations possible on the contract. The format of the permission is 'contract:' followed by the specific operation, like 'contract:create.' - `contract:delete` boolean, required - `contract:download:pdf` boolean, required - `contract:send` boolean, required - `_integration_permissions` object[] — A list of integration specific permissions. This exists only for specific integration tokens - `key` string, required - `value` string, required - `_private` object, required — See [Private](https://developer.oneflow.com/docs/contract#private) - `date_format` string, required — The date format of the contract. - `value` object, nullable, required — See [Contract value](https://developer.oneflow.com/docs/contract#value). - `amount` string, amount, required - `currency` string, currency, required - `folder` object, required — A folder. - `id` integer, required — Folder ID - `name` string, required — Folder name. - `parent_id` integer, nullable, required — If exist any parent folder, its ID. - `path` integer[], required — An array of folder IDs representing the path from the top of the hierarchy to the current folder. - `language` string — The language of the contract. - `name` string, required — The name of the contract. - `signing_period_expiration` union, required - object — The signing period for this contract never expires - `type` 'never', required — Can only be 'never'. - object — The signing period for this contract expires a given number of days after publishing. This setting can only be used when the contract is in the draft stage. Converts into a "fixed_date" after the contract is published. - `type` 'days_after_publish', required — Can only be 'days_after_publish'. - `expire_days_after_publish` integer, required - object — The signing period for this contract expires on a set date. - `type` 'fixed_date', required — Can only be 'fixed_date'. - `expire_date` string, date, required - `workspace_id` integer, nullable, required — The unique id of this workspace. - `single_sign` boolean — State of the feature single sign - `_private_ownerside` object, nullable, required — Contract data that is private to the ownerside. - `created_time` string, datetime, required - `template_id` integer, nullable, required - `template_type_id` integer, nullable, required - `playbook_id` integer, nullable - `blueprint_ids` integer[], nullable - `draft_approval_workflow` object, nullable — Draft approval work flow details. - `status` string, nullable - `id` integer, required - `imported` boolean, nullable — A flag denoting whether the contract has been imported or not. - `lifecycle_settings` object, nullable, required — See [Lifecycle settings](lifecycle-settings). - `duration` string, duration, nullable, required - `end_date` string, date, nullable, required - `initial_duration` string, duration, nullable, required - `notice_period` string, duration, nullable, required - `start_date` string, date, nullable, required - `type` 'no_duration' | 'single_period' | 'recurring' | 'recurring_two_periods' | 'unknown', required — One of the contract [duration types](contract#duration-type). - `lifecycle_state` object, nullable, required — Lifecycle information of the contract. See [Lifecycle state](https://developer.oneflow.com/docs/contract#lifecycle-state). - `composite` 'awaiting' | 'awaiting-recurring' | 'active' | 'active-recurring' | 'active-canceled-recurring' | 'ended' | 'ended-terminated' | 'ended-terminated-recurring', required — One of the [lifecycle composites](contract#lifecycle-composite). - `contract_end_time` string, datetime, nullable, required - `contract_start_time` string, datetime, nullable, required - `cancel_time` string, datetime, nullable, required - `has_ended_by_termination` boolean, required - `has_passed_notice_period_start_time` boolean, required - `is_canceled` boolean, required - `is_recurring` boolean, required - `lifecycle_state` 'awaiting' | 'active' | 'ended' | 'unknown', required — One of the [lifecycle states](ccontract#lifecycle-states). - `lifecycle_state_updated_time` string, datetime, required - `notice_period_start_time` string, datetime, nullable, required - `period` integer, nullable, required - `period_end_time` string, datetime, nullable, required - `period_start_time` string, datetime, nullable, required - `marked_as_signed` boolean, nullable — A flag denoting whether the contract has been marked as signed or not.This flag will be available in the signed state of contract. - `parties` union[], required — Total number of parties allowed per contract is 40. - union - object — An individual party, where a single participant is signing on behalf of him- or herself. See [Individual party](https://developer.oneflow.com/docs/party#individual) - `_links` object — Links to related endpoints. - `comments` object - … - `contracts` object - … - `contract` object - … - `create` object - … - `data_field` object - … - `data_fields` object - … - `events` object - … - `event` object - … - `files` object - … - `file` object - … - `next` object - … - `parties` object - … - `party` object - … - `previous` object - … - `publish` object - … - `self` object - … - `template_types` object - … - `template_type` object - … - `template` object - … - `templates` object - … - `workspaces` object - … - `workspace` object - … - `playbooks` object - … - `_private_ownerside` object, nullable, required — Party data that is private to the ownerside. - `created_time` string, datetime, required - `custom_id` string, nullable, required - `updated_time` string, datetime, nullable, required - `country_code` string, country_code, required - `id` integer, required - `identification_number` string, required - `my_party` boolean, required - `name` string, nullable, required - `participant` object, required — See [Participant](https://developer.oneflow.com/docs/participant). - `_links` object — Links to related endpoints. - … - `_permissions` object, required — This attribute contains the permissions for the participant/creator on the contract. - … - `_private_ownerside` object, nullable, required — Participant data that is private to the ownerside. - … - `delivery_channel` 'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown', required — One of the contract [delivery channels](contract#delivery-channels). - `delivery_status` 'not_sent' | 'pending' | 'failure' | 'bounce' | 'success' | 'opened' | 'unknown', required — One of the contract [delivery status](contract-participant#delivery-status). - `draft_approver` boolean — A flag to indicate if the participant is a draft approver. - `email` string, email, required - `id` integer, required - `identification_number` string, required - `my_participant` boolean, required - `name` string, nullable, required - `organizer` boolean, required — A flag to indicate if the participant is an organizer combined with the permissions. - `pending_approver` boolean — A flag to indicate if the participant is a pending approver. - `phone_number` string, nullable, required - `sign_method` 'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign' | 'unknown', required — One of the [sign methods](contract#sign-methods). - `sign_state` 'undecided' | 'signed' | 'declined' | 'unknown', required — One of the [sign states](contract-participant#sign-state). - `sign_state_updated_time` string, datetime, nullable, required - `signatory` boolean, required — A flag to indicate if the participant is an signatory combined with the permissions. - `title` string, required - `two_step_authentication_method` 'email' | 'sms' | 'personal_identification' | 'none' | 'unknown', required — One of the [two step authentication methods](contract#two-step-authentication-methods). - `type` 'individual', required — Can only be `individual`. - object — The participants are signing on behalf of this company. See [Company party](https://developer.oneflow.com/docs/party#company). - `_links` object — Links to related endpoints. - `comments` object - … - `contracts` object - … - `contract` object - … - `create` object - … - `data_field` object - … - `data_fields` object - … - `events` object - … - `event` object - … - `files` object - … - `file` object - … - `next` object - … - `parties` object - … - `party` object - … - `previous` object - … - `publish` object - … - `self` object - … - `template_types` object - … - `template_type` object - … - `template` object - … - `templates` object - … - `workspaces` object - … - `workspace` object - … - `playbooks` object - … - `_private_ownerside` object, nullable, required — Party data that is private to the ownerside. - `created_time` string, datetime, required - `custom_id` string, nullable, required - `updated_time` string, datetime, nullable, required - `country_code` string, country_code, required - `id` integer, required - `identification_number` string, required - `my_party` boolean, required - `name` string, required - `participants` object[], required — The maximum number of participants per contract across all parties is 40. - `_links` object — Links to related endpoints. - … - `_permissions` object, required — This attribute contains the permissions for the participant/creator on the contract. - … - `_private_ownerside` object, nullable, required — Participant data that is private to the ownerside. - … - `delivery_channel` 'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown', required — One of the contract [delivery channels](contract#delivery-channels). - `delivery_status` 'not_sent' | 'pending' | 'failure' | 'bounce' | 'success' | 'opened' | 'unknown', required — One of the contract [delivery status](contract-participant#delivery-status). - `draft_approver` boolean — A flag to indicate if the participant is a draft approver. - `email` string, email, required - `id` integer, required - `identification_number` string, required - `my_participant` boolean, required - `name` string, nullable, required - `organizer` boolean, required — A flag to indicate if the participant is an organizer combined with the permissions. - `pending_approver` boolean — A flag to indicate if the participant is a pending approver. - `phone_number` string, nullable, required - `sign_method` 'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign' | 'unknown', required — One of the [sign methods](contract#sign-methods). - `sign_state` 'undecided' | 'signed' | 'declined' | 'unknown', required — One of the [sign states](contract-participant#sign-state). - `sign_state_updated_time` string, datetime, nullable, required - `signatory` boolean, required — A flag to indicate if the participant is an signatory combined with the permissions. - `title` string, required - `two_step_authentication_method` 'email' | 'sms' | 'personal_identification' | 'none' | 'unknown', required — One of the [two step authentication methods](contract#two-step-authentication-methods). - `type` 'company', required — Can only be `company`. - `pending_approval_workflow` object, nullable — Pending approval work flow details. - `status` string, nullable - `published_time` string, datetime, nullable, required - `sign_later` boolean — A flag to indicate if the contract signing is postponed. - `sign_order` object[] — Sign order of the participants. - `participant_id` integer, required — participant ID - `order` integer, required — Sign order - `signing_period_expiry_time` string, datetime, nullable, required - `state` 'draft' | 'pending' | 'overdue' | 'signed' | 'declined' | 'unknown', required — One of the [contract states](contract#contract-state). - `state_updated_time` string, datetime, required - `tags` object[], required — All tags associated with the contract. - `id` integer, required - `name` string, required - `updated_time` string, datetime, nullable, required ## Other responses - `400` — Invalid format or content of the request. - `401` — The API token or the user email is invalid. --- [API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)