Forms

Forms are configured forms for specific objects, eg. projects. You can configure which fields are on the form.

Fetching a list of Forms

Returns all custom form mappings on the requester's account.

This endpoint returns structured Forms objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_app_items top-level JSON key. Please see our Response Format section for more information.

Request

query Parameters

created_after	string <date-time> Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.
created_before	string <date-time> Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.
location	string
matching	string
only	string Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`.
order	string Default: "created_at:asc" Supply `order` with the name of a valid sort field for the endpoint and a direction. Valid values: `alphabetical:asc`, `alphabetical:desc`, `created_at:asc`, and `created_at:desc`.
page	integer <int32> Default: 1
per_page	integer <int32> <= 200 Default: 20
updated_after	string <date-time> Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.
updated_before	string <date-time> Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

Responses

200

A list of Forms have been retrieved.

Response Schema: application/json

count	integer <int32>
	object
	Array of objects
	object

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/forms

Request samples

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"custom_app_items": {"property1": {"title": "string"
},
"property2": {"title": "string"
}
}
}

➔ Next to Insights Access Group Memberships