Skip to main content
GET
/
smart-fields
List smart fields
curl --request GET \
  --url https://api.tomorro.com/v2/smart-fields \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Contract Value",
      "type": "number"
    }
  ],
  "pagination": {
    "limit": 20,
    "next_cursor": "eyJpZCI6IjEyMyJ9",
    "prev_cursor": "eyJpZCI6IjEwMCJ9",
    "has_next": true,
    "has_previous": false
  },
  "links": {
    "self": "/smart-fields?limit=20",
    "next": "/smart-fields?limit=20&after=eyJpZCI6IjEyMyJ9",
    "prev": "/smart-fields?limit=20&before=eyJpZCI6IjEwMCJ9"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

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"

​
object
string

Filter by object type. Formats: object=contract (equality), object=in:contract,external_party (in list)

Example:

"contract"

​
lang
enum<string>

Language code for the smart field name. Falls back to the default name when no translation exists.

Available options:
fr,
gb,
us,
es,
de,
it,
nl,
ru,
pt,
br,
jp,
gr,
pl,
si,
id,
zh-cn,
zh-tw,
hi,
vi,
uk,
th,
bg,
hr,
dk,
ee,
fi,
hu,
ie,
lv,
lt,
ro,
sk,
se,
cz,
no,
uz,
tj,
at,
is,
rs
Example:

"gb"

Response

List of smart fields with pagination info

​
data
object[]
required

An array of SmartField objects.

Example:
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Contract Value",
    "type": "number"
  }
]
​
pagination
object
required

Pagination metadata including cursors and navigation flags.

Example:
{
  "limit": 20,
  "next_cursor": "eyJpZCI6IjEyMyJ9",
  "prev_cursor": "eyJpZCI6IjEwMCJ9",
  "has_next": true,
  "has_previous": false
}
​
links
object
required

HATEOAS navigation links for pagination.

Example:
{
  "self": "/smart-fields?limit=20",
  "next": "/smart-fields?limit=20&after=eyJpZCI6IjEyMyJ9",
  "prev": "/smart-fields?limit=20&before=eyJpZCI6IjEwMCJ9"
}