Skip to main content
GET
/
contracts
List contracts
curl --request GET \
  --url http://localhost:3015/contracts \
  --header 'x-api-key: <api-key>'
{
  "contracts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Service Agreement - Acme Corp",
      "status": "draft"
    }
  ],
  "hasNext": true,
  "hasPrevious": false
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/api

Query Parameters

​
limit
number
default:20

Number of items per page (1-50)

Required range: 1 <= x <= 50
Example:

20

​
after
string

Cursor for forward pagination. Use the next_cursor value from a previous response.

Example:

"eyJpZCI6IjEyMyJ9"

​
before
string

Cursor for backward pagination. Use the prev_cursor value from a previous response.

Example:

"eyJpZCI6IjEwMCJ9"

​
sort
string

Sort order. Comma-separated list of fields. Prefix with - for descending order.

Example:

"-createdAt,role"

​
status
string

Filter by name. Formats: status=draft (equality), status=ne:negotiating (not equals), name=in:signing,signed (in list)

Example:

"draft"

​
authorId
string

Filter by author member ID

Example:

"123"

​
counterpartyId
string

Filter by counterparty ID

Example:

"456"

​
contractTypeId
string

Filter by contract type ID

Example:

"101"

​
referentId
string

Filter by referent member ID

Example:

"202"

​
supervisorId
string

Filter by supervisor member ID

Example:

"303"

​
folderId
string

Filter by folder ID

Example:

"404"

​
startAt
string

Filter by start date. Formats: startAt=2024-01-01 (equality), startAt=gte:2024-01-01 (greater than or equal), startAt=lte:2024-12-31 (less than or equal)

Example:

"2024-01-01"

​
endAt
string

Filter by end date. Formats: endAt=2024-12-31 (equality), endAt=gte:2024-01-01 (greater than or equal), endAt=lte:2024-12-31 (less than or equal)

Example:

"2024-12-31"

​
createdAt
string

Filter by creation date. Formats: createdAt=2024-01-01 (equality), createdAt=gte:2024-01-01 (greater than or equal), createdAt=lte:2024-12-31 (less than or equal)

Example:

"2024-01-01"

Response

List of contracts

​
contracts
object[]
required

An array of Contract objects.

Example:
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Service Agreement - Acme Corp",
    "status": "draft"
  }
]
​
hasNext
boolean
required

Whether there are more results available after this page. If true, you can use the after cursor to fetch the next page.

Example:

true

​
hasPrevious
boolean
required

Whether there are results available before this page. If true, you can use the before cursor to fetch the previous page.

Example:

false