Document Operations

List document's conditions

Changed on

<small>Requires an API token with the Document Reader role.</small>

Lists a document's conditions and tells you which of them currently apply.

A condition's is_active value is derived from the document's dynamic field values, so updating a field via the update dynamic field endpoint may change which conditions are active.

get/documents/{document}/conditions

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/documents/{document}/conditions
  • Auth
    HTTP bearer

Path parameters

documentstring required

The document UUID

Response

Array of ConditionResource

Example response

{
  "data": [
    {
      "uuid": "0b7e6e33-1f3c-4b3e-9a1a-2a0d6bb0f1c2",
      "name": "Includes probation period"
    }
  ]
}

Changes