You can retrieve all templates of a workspace (max 50). To do so, send a request to GET /v1/templates and pass a series of optional filters to refine you request.
curl
https://api.universign.com/v1/templates?size=2
Optional parameters
size: The number of templates you want to retrieve, starting from the most recent. Default is50.ending_before: Expected value is a template ID. Use for pagination to return the templates listed before the specified template. Do not pass if you set thestarting_afterparameter.starting_after: Expected value is a template ID. Use for pagination to return the templates listed after the specified template. Do not pass if you set theending_beforeparameter.folder_id: Returns only templates associated with this folder ID.creator: Expected value is an email address. Returns only templates created by the workspace member associated with this email.state: Returns only templates with the requested state. Possible valuesdraftorpublished.issuing_entity_id: Returns only templates created by a given issuing entity.
The API returns the list of all templates matching your request.
{
"has_more" : false,
"content" : [ {
"object" : "template",
"id" : "tpl_wXzwBdJe91Y6",
"folder_id" : "fol_JxmJlV5P922X",
"created_at" : "2024-02-09T13:45:11Z",
"duration" : 20160,
"template_name" : "Nouveau modèle",
"folder_name" : "Default folder",
"language" : "fr",
"sender_name_display" : "issuing_entity",
"creator" : {
"name" : "Koussai HOUSSINE",
"email" : "koussai.houssine@universign.com",
"workspace_name" : "DemoWS"
},
"state" : "published",
"publishable" : true,
"participants" : [ {
"email" : "jane.doe@universign.com",
"phone_number_type" : "suggestion",
"min_signature_level" : "level1",
"schedule" : [ 0 ],
"ongoing_conversation" : false,
"has_unread_message" : false,
"waiting_period" : 0,
"shared_contact" : false,
"full_name_type" : "suggestion"
} ],
"sealers" : [ ],
"documents" : [ {
"id" : "doc_Pdk",
"name" : "Contract template.pdf",
"name_locked" : true,
"type" : "final",
"updatable" : true,
"deletable" : false,
"fields" : [ {
"id" : "fld_gg6M",
"position" : {
"page" : 2,
"x" : 323,
"y" : 419,
"width" : 200,
"height" : 50
},
"type" : "signature",
"built_in" : false,
"consents" : [ ],
"optional_consents" : [ ],
"updatable" : true,
"deletable" : false
} ],
"editable" : true
} ],
"field_groups" : [ {
"id" : "fld_gg6M",
"type" : "field",
"fields" : [ "fld_gg6M" ]
} ],
"instructions" : {
"signatures" : [ {
"signer" : "jane.doe@universign.com",
"field" : "fld_gg6M"
} ],
"reviews" : [ ],
"captures" : [ ],
"sequencing" : [ ],
"editions" : [ ]
},
"actions" : [ {
"id" : "act_vQ115egKy31gE",
"actor" : "jane.doe@universign.com",
"tasks" : [ {
"type" : "signature",
"field" : "fld_gg6M"
} ]
} ],
"action_graph" : {
"act_vQ115egKy31gE" : [ "end" ],
"start" : [ "act_vQ115egKy31gE" ]
},
"metadata" : { },
"carbon_copies" : [ ],
"allow_carbon_copy" : false,
"last_publication_date" : "2024-02-09T13:45:35Z",
"last_publisher" : {
"name" : "Koussai HOUSSINE",
"email" : "koussai.houssine@universign.com",
"workspace_name" : "DemoWS"
},
"issuing_entity" : {
"active" : true,
"name" : "DemoWS",
"id" : "iss_xa1LoEebXQM3"
}
}, {
"object" : "template",
"id" : "tpl_agMgvOzLya3k",
"folder_id" : "fol_JxmJlV5P922X",
"created_at" : "2023-10-02T09:07:07Z",
"duration" : 20160,
"template_name" : "New template",
"folder_name" : "Default folder",
"transaction_name" : "Contract John",
"language" : "fr",
"sender_name_display" : "name_email_issuing_entity",
"creator" : {
"name" : "Demo Workspace",
"email" : "koussai.houssine@universign.com",
"workspace_name" : "DemoWS"
},
"state" : "published",
"publishable" : true,
"participants" : [ {
"email" : "$1707402147899",
"designation" : "Insured",
"phone_number_type" : "suggestion",
"request_phone_number" : false,
"min_signature_level" : "level1",
"schedule" : [ 0 ],
"ongoing_conversation" : false,
"has_unread_message" : false,
"waiting_period" : 0,
"shared_contact" : false,
"request_full_name" : false,
"full_name_type" : "suggestion"
} ],
"sealers" : [ ],
"documents" : [ {
"id" : "doc_aX4",
"name" : "Specimen 1.pdf",
"name_locked" : true,
"type" : "specimen",
"updatable" : true,
"deletable" : false,
"fields" : [ {
"id" : "fld_3ZK",
"position" : {
"page" : 1,
"x" : 192,
"y" : 95,
"width" : 200,
"height" : 50
},
"type" : "signature",
"built_in" : false,
"consents" : [ ],
"optional_consents" : [ ],
"updatable" : true,
"deletable" : false
} ],
"editable" : true
} ],
"field_groups" : [ {
"id" : "fld_3ZK",
"type" : "field",
"fields" : [ "fld_3ZK" ]
} ],
"instructions" : {
"signatures" : [ {
"signer" : "$1707402147899",
"field" : "fld_3ZK"
} ],
"reviews" : [ ],
"captures" : [ ],
"sequencing" : [ ],
"editions" : [ ]
},
"actions" : [ {
"id" : "act_5X78AeekMZlvq",
"actor" : "$1707402147899",
"tasks" : [ {
"type" : "signature",
"field" : "fld_3ZK"
} ]
} ],
"action_graph" : {
"act_5X78AeekMZlvq" : [ "end" ],
"start" : [ "act_5X78AeekMZlvq" ]
},
"metadata" : { },
"carbon_copies" : [ ],
"allow_carbon_copy" : false,
"last_publication_date" : "2024-02-08T14:57:53Z",
"last_publisher" : {
"name" : "Koussai HOUSSINE",
"email" : "koussai.houssine@universign.com",
"workspace_name" : "DemoWS"
},
"issuing_entity" : {
"active" : true,
"name" : "Test_entity",
"id" : "iss_w9nmLe9qzYDy"
}
} ]
}
