Skip to main content
GET
/
contract-types
/
{id}
/
creation-form
Get contract types creation form
curl --request GET \
  --url https://api.tomorro.com/v2/contract-types/{id}/creation-form \
  --header 'x-api-key: <api-key>'
{
  "fields": [
    {
      "smartFieldId": "550e8400-e29b-41d4-a716-446655440000",
      "typeAttributeId": "650e8400-e29b-41d4-a716-446655440001",
      "reasons": [
        "explicitMandatory"
      ],
      "required": true
    }
  ],
  "fieldsCount": 3,
  "rules": [
    {
      "conditions": {
        "all": []
      },
      "event": {
        "type": "noop"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://alpha.developer.tomorro.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string
required

The unique identifier (UUID) of the contract type

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

​
templateId
string

Optional template id to scope conditions (e.g. template-based mandatory fields).

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Creation form fields and rules

​
fields
object[]
required

Fields to collect when creating a contract of this type (and optional template).

Example:
[
  {
    "smartFieldId": "550e8400-e29b-41d4-a716-446655440000",
    "typeAttributeId": "650e8400-e29b-41d4-a716-446655440001",
    "reasons": ["explicitMandatory"],
    "required": true
  }
]
​
fieldsCount
number
required

Number of fields (same as fields.length).

Example:

3

​
rules
object[]
required

Json-rules-engine rule definitions applied to the creation form.

Example:
[
  {
    "conditions": { "all": [] },
    "event": { "type": "noop" }
  }
]