Skip to main content
Nintex Community Menu Bar

I see in the April 2025 Release Notes that there is a new feature --

“Import / Export Workflow File via API: You can now use the Nintex Workflow API to import and export workflow file-based definitions.“

in the API page, it says, “Export a published workflow design to import it into another tenant.”

I was wondering, “What if I don’t want to import into another tenant?”

Can I simply export it from a custom program and store the workflow definition file in a repository, so I have some kind of software versioning process?

Maybe -- I might have to try it out.  But I was going to check here first if anyone else has already done this.

If not, I will develop something and post it here for your use.

Hi ​@PabloL  

I haven’t done this yet either but the answer for if you can store it in a repository should be yes.  The export functionality is the export a packaged workflow which contains the design definition for the workflow.  You can find the API documentation for it here: https://developer.nintex.com/docs/nw-api-docs/ref/workflows-v1/operations/create-a-design-package-export.  The API will return a zip file that you could then store in your repository.  You should also be able to use the API to import previously packaged workflows as well: https://developer.nintex.com/docs/nw-api-docs/ref/workflows-v1/operations/create-a-design-package-import


PabloL, we regularly export our Nintex workflows to a library for versioning and documentation purposes as you describe. We save them in a specific SharePoint library and setup properties to track where the workflows are employed, etc.

Currently this is a manual process, since we want our workflow authors to take responsibility for archiving and documenting the workflows according to our standards. The ability to export these workflows is a big plus for Nintex.

Regards,

Gerard


Hi,

 

Attached is an example extension that accepts a workflow ID to download the workflow export zip.

It's configured for US tenants, but you can easily update the URL in the swagger file if your tenant is in another region. It’s configured to use a personal access token, which means it will only download workflows for which the user has permissions. This could also be updated. Combining this with the list workflows api could automate the archiving of a tenant’s workflows.


Thanks, ​@SimonMuntz 

 

I do want to configure it to get all the workflows, not merely the ones based on user permission.

 

I am getting an error, “The user does not have permission to access the workflow.”

 

This is even happening on my own workflows. So something is wrong with the connection that I set up.

 

Can you provide any suggestions on how to set up that access token?


Following up -- it turns out that this error was because my user was not the “owner” of the workflow, even though it was the “author” of the workflow. I don’t know how to ensure that I am the “owner” before it runs the “export” action and hits that error.

 

I can check if the name or email of the author matches, but I don’t know how to get Owner, so I can’t prevent it from running the “export” on a workflow that does not have permission by this user.

 

Any suggestions?


Hi ​@PabloL,

The list workflow permissions API lists the workflow owners.
https://developer.nintex.com/docs/nw-api-docs/ref/workflows-v1/operations/list-design-permissions

If it returns that you are not an owner, you could update the permissions with this API before doing the export.
https://developer.nintex.com/docs/nw-api-docs/ref/workflows-v1/operations/update-a-design-permission


Reply