v1

latestOpenAPI 3.0.02026-07-24115101.2 MB

Contract

Get contracts

Use this endpoint to retrieve the list of contracts.

get/contracts

Query parameters

offsetinteger

limitinteger

sortstring

A comma-separated list of columns by which results are sorted. Valid columns:

name
state
state_updated_time
published_time

filter[canceled]'true' | 'false'

Filter contracts by whether the contract lifecycle has been canceled or not.

filter[closed_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the sign or decline timestamp is within the specified datetime range.

filter[created_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the created timestamp is within the specified datetime range.

filter[data_field_match]string

Filter contracts where the given data field has a given value. The format for this parameter is filter[data_field_match]=<data-field-custom-id>:<value> Dont forget to URL escape the value as it can be any Unicode string. The value can't be the empty string.

filter[email]string email

Filter contracts where the email of one of the participants matches the given value.

filter[folder_ids]string

Filter contracts with folders that are in the specified comma-separated list of folder IDs.

filter[id]string

Retrieve specific contracts by providing a comma-separated list of contract IDs. Note: Other filters still apply if specified.

filter[lifecycle_started_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the lifecycle start timestamp is within the specified datetime range.

filter[lifecycle_states]string

Filter contracts where the lifecycle state is one of the specified states in a comma-separated list. See lifecycle-state for allowed values.

filter[participant_custom_id]string

Filter contracts where the custom_id of one of the participants matches the given value.

filter[participant_identification_number]string

Filter contracts where the identification_number of one of the participants matches the given value.

filter[published_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the publish timestamp is within the specified datetime range.

filter[query]string

Free text search in the following fields:

participant fullname
participant title
participant ssn
participant phone number
participant email
party org number
party phone number
data field value
tag name
contract name

filter[states]string

Filter contracts where the contract state is one of the specified states in a comma-separated list. See state for allowed values.

filter[upcoming_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the next upcoming event is within the specified datetime range. Here, an event refers to the signing period expiration or a lifecycle event (start, end, renewal).

filter[updated_time]string

Example:2022-01-02T03:04:05+02:00|2022-05-06T07:08:09-05:00

Filter contracts where the contract was last updated within the specified datetime range.

filter[workspace_ids]string

Filter contracts from workspaces that are in the specified comma-separated list of workspace IDs. Filter contracts from workspaces that are in the specified comma-separated list of workspace IDs. To retrieve contracts from the "Shared with Me" workspace, use the workspace ID as 0.

filter[tag_ids]string

Filter contracts with tags that are in the specified comma-separated list of tag IDs.

filter[template_ids]string

Filter contracts with templates that are in the specified comma-separated list of template IDs.

filter[playbook_ids]string

Filter contracts with playbooks that are in the specified comma-separated list of playbook IDs.

filter[blueprint_ids]string

Filter contracts with blueprints that are in the specified comma-separated list of blueprint IDs.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Response

Returns the list of all contracts in the specified account.

countinteger required