template-id

printable US-ASCII string

Confluence page or Jira issue identifier.

statuses

"any"
"sent"
"ongoing"
"rejected"
"signed"
"expired"
"sent|ongoing"
"rejected|signed|expired"
or any other combination

Searches for contracts with the specified statuses only. Defaults to "any".

substring

nonempty Unicode string

Searches for contracts with a specified substring in a contract name or in a signer name or email. Case insensitive operation.

creator-id

Atlassian user id

Searches for contracts created by a specified Atlassian user only.

placement

"any"
"stacked"
"archived"

Searches for contracts from specified place only. Default to "stacked".

date-range

iso8601date
iso8601date~
~iso8601date
iso8601date~iso8601date

Searches for contracts created:

• iso8601date - on the specified date

• iso8601date~ - on or after the specified date

• ~iso8601date - before or on the specified date

• iso8601date~iso8601date - between specified dates inclusive

Example: "2022-10-01~2022-10-31"

time-zone

time zone identifier

A time-zone identifier, such as "Europe/Paris", "Z", "UTC" or "UTC+01:00". Defaults to "UTC". Defines time zone in which date-range parameter is interpreted.

order

"random"
"creation-date-asc"
"creation-date-desc"
"name-asc"
"name-desc"
"creator-id-asc"
"creator-id-desc"

Defines the order in which contracts are returned.

page

positive integer

Number of page with contracts. Defaults to 1.

page-size

positive integer

Number of contracts per page. Defaults to 10. Allowed maximum is 100.

templateId

printable US-ASCII string

Confluence page or Jira issue identifier from which a contract will be created.

required

"1234567"

name

printable Unicode string

Name of a contract.

required

"NDA"

sequentialSigning

boolean

Will the invitation email be sent after a previous signer decision ? Defaults to false.

optional

true

signers

array of Signer Creation Objects

At least one signer is required. No more then 26 signers are allowed.

required

fullName

printable Unicode string

Full name of a signer.

required

“Richard Roe”

accessKind

"email" or "url"

How the signer will access the sign page ?

required

"email"

email

email

Email address on which the signer will receive an URL to the signing page. An OTP will also be sent here if "phone" is not set. Required for "accessKind" set to "email" and optional for "accessKind" set to "url".

conditional

"richard.roe@company.com"

phone

E.164

Mobile phone number in the international format on which OTP will be sent.

optional

"+49 172-9973185"

appendSignatureMacro

boolean

Should signature macro for this signer be appended at the end of the contract ? Defaults to false.

optional

true

receivesCompletedContract

boolean

Should signer receive completed contract on her/his email ? Defaults to true.

optional

false