List custom fields
curl --request GET \
--url https://my.flowsign.app/api/v1/custom-fields \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/custom-fields"
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/custom-fields");
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": [
{
"key": "<string>",
"label": "<string>",
"helpText": "<string>",
"isRequired": true,
"scope": "all",
"templateIds": [
"<string>"
],
"order": 123
}
]
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Custom fields
List custom fields
Returns the organisation’s active custom field definitions in display order. key is the key a package’s metadata uses. scope is all for a field on every package, or templates for a field only on packages launched from one of templateIds. templateId narrows the list to the fields a package launched from that template carries. isRequired fields MUST be filled before a package is sent. A plan without custom fields answers 402.
GET
/
api
/
v1
/
custom-fields
List custom fields
curl --request GET \
--url https://my.flowsign.app/api/v1/custom-fields \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.flowsign.app/api/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/custom-fields"
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/custom-fields");
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": [
{
"key": "<string>",
"label": "<string>",
"helpText": "<string>",
"isRequired": true,
"scope": "all",
"templateIds": [
"<string>"
],
"order": 123
}
]
}{
"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
Minimum string length:
1Response
Success
Show child attributes
Show child attributes
Was this page helpful?

