Skip to main content
GET
Search RecordCreationWorkflowVersions
A mutable draft or immutable published version of a record creation workflow.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RecordCreationWorkflowVersion-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by workflow that owns this version.
integer
Filter by monotonic version number within the workflow.
integer
Filter by version of the persisted workflow document contract.
string
Filter by full JSON workflow document.
string
Filter by deterministic hash of the workflow document.
boolean
Filter by whether this version remains mutable.
string
Filter by last validation result for diagnostics.
string
Filter by date and time this immutable version was published.
integer
Filter by user who published this version.
string
Filter by display value for PublishedByUser.FullName..
string
Filter by display value for PublishedByUser.Email..
string
Filter by optimistic concurrency token changed on every draft save.

Range Filters

integer
Filter by monotonic version number within the workflow greater than or equal to this value.
integer
Filter by monotonic version number within the workflow less than or equal to this value.
integer
Filter by version of the persisted workflow document contract greater than or equal to this value.
integer
Filter by version of the persisted workflow document contract less than or equal to this value.
string
Filter by date and time this immutable version was published greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date and time this immutable version was published less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by DefinitionJson

Range filters

Response

200

RecordCreationWorkflowVersion[]
The list of RecordCreationWorkflowVersion records matching the query. See the Get one RecordCreationWorkflowVersion endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each RecordCreationWorkflowVersion. The following fields are not populated in the Records[] response: DefinitionJson, ValidationJson, PublishedByUserId.To get all fields, fetch the full record using the Get one RecordCreationWorkflowVersion endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response