Get package
curl --request GET \
--url https://my.flowsign.app/api/v1/packages/{packageId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"id": "<string>",
"title": "<string>",
"status": "DRAFT",
"description": "<string>",
"recipients": [
{
"name": "<string>",
"email": "<string>",
"action": "<string>",
"actionType": "SIGNER",
"delay": 123
}
],
"emailSubject": "<string>",
"emailMessage": "<string>",
"signingOrder": 123,
"documents": [
{
"id": "<string>",
"title": "<string>",
"pageCount": 123
}
],
"recipientSessions": [
{
"id": "<string>",
"recipientName": "<string>",
"recipientEmail": "<string>",
"status": "WAITING",
"order": 123,
"sentAt": "<string>",
"openedAt": "<string>",
"completedAt": "<string>",
"declinedAt": "<string>",
"declineReason": "<string>"
}
],
"auditEvents": [
{
"id": "<string>",
"eventType": "<string>",
"actorEmail": "<string>",
"createdAt": "<string>",
"metadata": null
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"expiresAt": "<string>",
"completedAt": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Packages
Get package
Returns the package with recipients, documents, signing sessions, custom field values as metadata, and the last 100 audit events.
GET
/
api
/
v1
/
packages
/
{packageId}
Get package
curl --request GET \
--url https://my.flowsign.app/api/v1/packages/{packageId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"id": "<string>",
"title": "<string>",
"status": "DRAFT",
"description": "<string>",
"recipients": [
{
"name": "<string>",
"email": "<string>",
"action": "<string>",
"actionType": "SIGNER",
"delay": 123
}
],
"emailSubject": "<string>",
"emailMessage": "<string>",
"signingOrder": 123,
"documents": [
{
"id": "<string>",
"title": "<string>",
"pageCount": 123
}
],
"recipientSessions": [
{
"id": "<string>",
"recipientName": "<string>",
"recipientEmail": "<string>",
"status": "WAITING",
"order": 123,
"sentAt": "<string>",
"openedAt": "<string>",
"completedAt": "<string>",
"declinedAt": "<string>",
"declineReason": "<string>"
}
],
"auditEvents": [
{
"id": "<string>",
"eventType": "<string>",
"actorEmail": "<string>",
"createdAt": "<string>",
"metadata": null
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"expiresAt": "<string>",
"completedAt": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace to act in, from GET /api/v1/workspaces. Omit to act in the organisation's default workspace. A workspace the key's user cannot act in is treated as omitted.
Path Parameters
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

