List packages
curl --request GET \
--url https://my.flowsign.app/api/v1/packages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/packages', 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"
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");
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": {
"packages": [
{
"id": "<string>",
"title": "<string>",
"status": "DRAFT",
"description": "<string>",
"recipients": [
{
"name": "<string>",
"email": "<string>",
"action": "<string>",
"actionType": "SIGNER",
"signed": true,
"delay": 123
}
],
"documentsCount": 1,
"signingProgress": {
"completed": 1,
"total": 1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"expiresAt": "<string>",
"completedAt": "<string>",
"metadata": {}
}
],
"totalCount": 1,
"page": 2,
"pageSize": 2
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Packages
List packages
Returns a paginated list of packages visible to the caller. Honours the caller’s package-visibility permissions.
GET
/
api
/
v1
/
packages
List packages
curl --request GET \
--url https://my.flowsign.app/api/v1/packages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/packages', 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"
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");
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": {
"packages": [
{
"id": "<string>",
"title": "<string>",
"status": "DRAFT",
"description": "<string>",
"recipients": [
{
"name": "<string>",
"email": "<string>",
"action": "<string>",
"actionType": "SIGNER",
"signed": true,
"delay": 123
}
],
"documentsCount": 1,
"signingProgress": {
"completed": 1,
"total": 1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"expiresAt": "<string>",
"completedAt": "<string>",
"metadata": {}
}
],
"totalCount": 1,
"page": 2,
"pageSize": 2
}
}{
"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.
Query Parameters
Available options:
DRAFT, SCHEDULED, IN_PROGRESS, COMPLETED, DECLINED, ON_HOLD, VOID Minimum string length:
1Required range:
x >= 1Required range:
1 <= x <= 100Response
Success
Show child attributes
Show child attributes
Was this page helpful?

