Get contracts

get

https://{hostname}/v1/contracts

Use this endpoint to retrieve the list of contracts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

0 to 19900

Defaults to 0

limit

integer

1 to 100

Defaults to 100

sort

string

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

name
state
state_updated_time
published_time

filter[canceled]

string

enum

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

Allowed:

filter[closed_time]

string

length ≤ 60

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

filter[created_time]

string

length ≤ 60

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

filter[data_field_match]

string

length ≤ 600

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

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

filter[folder_ids]

string

length ≤ 100

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

filter[id]

string

length ≤ 200

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

filter[lifecycle_started_time]

string

length ≤ 60

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

filter[lifecycle_states]

string

length ≤ 100

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

length ≤ 100

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

filter[participant_identification_number]

string

length ≤ 100

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

filter[published_time]

string

length ≤ 60

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

filter[query]

string

length ≤ 300

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

length ≤ 100

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

length ≤ 60

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

length ≤ 60

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

filter[workspace_ids]

string

length ≤ 100

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

length ≤ 100

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

Headers

x-oneflow-api-token

string

required

length between 40 and 40

The API key of your Oneflow account.

x-oneflow-user-email

string

The email address of a registered Oneflow user.

Responses

400

Invalid format or content of the request.

401

The API token or the user email is invalid.

200Returns the list of all contracts in the specified account.