Lists all People Flow Steps within a given People Flow, including Instruction and Description data The fields listed here will be returned when this method is called.
POSThttps://api.elvanto.com/v1/peopleFlows/steps/getAll.{json|xml|php}
| Name | Type | Description |
|---|---|---|
| flow_id Required | string | The UUID of the People Flow you wish to get the Steps for |
{
"flow_id": "2449eaa0-1058-11e5-bd65-06e37142e2e1"
}flow_id=2449eaa0-1058-11e5-bd65-06e37142e2e1{
"generated_in": "0.68",
"status": "ok",
"people_flow_steps": {
"on_this_page": 3,
"page": 1,
"per_page": 3,
"total": 3,
"people_flow_step": [
{
"priority": "1",
"status": "",
"name": "Initial Email",
"description": "Initial "Welcome to church" email.",
"instructions": "First print all letters for those who have not got email addresses, then mark everyone as complete in the step and the emails will automatically be sent.",
"notifications": "y",
"entry_point": "",
"step_due": {
"type": ""
},
"admins": [
{
"id": "bc49f10f-0333-11e5-bd65-06e37142e2e1",
"role": "Youth"
},
{
"id": "b96e2c40-0333-11e5-bd65-06e37142e2e1",
"role": ""
}
],
"id": "d852e973-1058-11e5-bd65-06e37142e2e1",
"steps": [
{
"priority": "1",
"status": "",
"name": "Phone Call",
"description": "First phone call someone receives when they are new to church.",
"instructions": "Call person. If you don't get on to them, make a note and mark their status to "In Progress". If you speak to the person, make a note and mark as Completed.",
"notifications": "y",
"entry_point": "",
"step_due": {
"type": "days",
"days": "3"
},
"admins": [
{
"id": "bc2c9a5f-0333-11e5-bd65-06e37142e2e1",
"role": ""
}
],
"id": "0dc1474d-1059-11e5-bd65-06e37142e2e1",
"steps": [
{
"priority": "1",
"status": "",
"name": "4 Week Phone Call",
"description": "Person receives another phone call after 4 weeks.",
"instructions": "After calling, write a note and mark as Completed. Once marked Completed, choose whether they are Connecting or Not Connecting.",
"notifications": "y",
"entry_point": "",
"step_due": {
"type": "days",
"days": 30
},
"admins": [
{
"id": "bb7955cc-0333-11e5-bd65-06e37142e2e1",
"role": ""
}
],
"id": "1b2d9759-1314-11e5-bd65-06e37142e2e1",
"steps": []
}
]
}
]
},
{
"priority": "2",
"status": "",
"name": "Connected",
"description": "Once marked as Completed from here, the person moves from being a New Person to a Church Member.",
"instructions": "",
"notifications": "",
"entry_point": "",
"step_due": "",
"admins": [],
"id": "2cec5d9b-1314-11e5-bd65-06e37142e2e1",
"steps": []
},
{
"priority": "3",
"status": "",
"name": "Not Connected",
"description": "If a person no longer wants to be contacted and does not want to connect with the church they are added to this step. Only Flow Admins can remove people from this step.",
"instructions": "Once marked as Completed, a person moves from New Person to Inactive",
"notifications": "",
"entry_point": "",
"step_due": "",
"admins": [],
"id": "39c21fac-1314-11e5-bd65-06e37142e2e1",
"steps": []
}
]
}
}<?xml version="1.0" encoding="UTF-8"?>
<rsp>
<generated_in>0.68</generated_in>
<status>ok</status>
<people_flow_steps>
<on_this_page>3</on_this_page>
<page>1</page>
<per_page>3</per_page>
<total>3</total>
<people_flow_step id="d852e973-1058-11e5-bd65-06e37142e2e1">
<priority>1</priority>
<status></status>
<name>Initial Email</name>
<description>Initial &quot;Welcome to church&quot; email.</description>
<instructions>First print all letters for those who have not got email addresses, then mark everyone as complete in the step and the emails will automatically be sent.</instructions>
<notifications>y</notifications>
<entry_point></entry_point>
<step_due>
<type></type>
</step_due>
<admins id="bc49f10f-0333-11e5-bd65-06e37142e2e1">
<role>Youth</role>
</admins>
<admins id="b96e2c40-0333-11e5-bd65-06e37142e2e1">
<role></role>
</admins>
<steps id="0dc1474d-1059-11e5-bd65-06e37142e2e1">
<priority>1</priority>
<status></status>
<name>Phone Call</name>
<description>First phone call someone receives when they are new to church.</description>
<instructions>Call person. If you don&#039;t get on to them, make a note and mark their status to &quot;In Progress&quot;. If you speak to the person, make a note and mark as Completed.</instructions>
<notifications>y</notifications>
<entry_point></entry_point>
<step_due>
<type>days</type>
<days>3</days>
</step_due>
<admins id="bc2c9a5f-0333-11e5-bd65-06e37142e2e1">
<role></role>
</admins>
<steps id="1b2d9759-1314-11e5-bd65-06e37142e2e1">
<priority>1</priority>
<status></status>
<name>4 Week Phone Call</name>
<description>Person receives another phone call after 4 weeks.</description>
<instructions>After calling, write a note and mark as Completed. Once marked Completed, choose whether they are Connecting or Not Connecting.</instructions>
<notifications>y</notifications>
<entry_point></entry_point>
<step_due>
<type>days</type>
<days>30</days>
</step_due>
<admins id="bb7955cc-0333-11e5-bd65-06e37142e2e1">
<role></role>
</admins>
<steps/>
</steps>
</steps>
</people_flow_step>
<people_flow_step id="2cec5d9b-1314-11e5-bd65-06e37142e2e1">
<priority>2</priority>
<status></status>
<name>Connected</name>
<description>Once marked as Completed from here, the person moves from being a New Person to a Church Member.</description>
<instructions></instructions>
<notifications></notifications>
<entry_point></entry_point>
<step_due></step_due>
<admins/>
<steps/>
</people_flow_step>
<people_flow_step id="39c21fac-1314-11e5-bd65-06e37142e2e1">
<priority>3</priority>
<status></status>
<name>Not Connected</name>
<description>If a person no longer wants to be contacted and does not want to connect with the church they are added to this step. Only Flow Admins can remove people from this step.</description>
<instructions>Once marked as Completed, a person moves from New Person to Inactive</instructions>
<notifications></notifications>
<entry_point></entry_point>
<step_due></step_due>
<admins/>
<steps/>
</people_flow_step>
</people_flow_steps>
</rsp>
stdClass Object
(
[generated_in] => 0.68
[status] => ok
[people_flow_steps] => stdClass Object
(
[on_this_page] => 3
[page] => 1
[per_page] => 3
[total] => 3
[people_flow_step] => stdClass Object
(
[0] => stdClass Object
(
[priority] => 1
[status] =>
[name] => Initial Email
[description] => Initial "Welcome to church" email.
[instructions] => First print all letters for those who have not got email addresses, then mark everyone as complete in the step and the emails will automatically be sent.
[notifications] => y
[entry_point] =>
[step_due] => stdClass Object
(
[type] =>
)
[admins] => stdClass Object
(
[0] => stdClass Object
(
[id] => bc49f10f-0333-11e5-bd65-06e37142e2e1
[role] => Youth
)
[1] => stdClass Object
(
[id] => b96e2c40-0333-11e5-bd65-06e37142e2e1
[role] =>
)
)
[id] => d852e973-1058-11e5-bd65-06e37142e2e1
[steps] => stdClass Object
(
[0] => stdClass Object
(
[priority] => 1
[status] =>
[name] => Phone Call
[description] => First phone call someone receives when they are new to church.
[instructions] => Call person. If you don't get on to them, make a note and mark their status to "In Progress". If you speak to the person, make a note and mark as Completed.
[notifications] => y
[entry_point] =>
[step_due] => stdClass Object
(
[type] => days
[days] => 3
)
[admins] => stdClass Object
(
[0] => stdClass Object
(
[id] => bc2c9a5f-0333-11e5-bd65-06e37142e2e1
[role] =>
)
)
[id] => 0dc1474d-1059-11e5-bd65-06e37142e2e1
[steps] => stdClass Object
(
[0] => stdClass Object
(
[priority] => 1
[status] =>
[name] => 4 Week Phone Call
[description] => Person receives another phone call after 4 weeks.
[instructions] => After calling, write a note and mark as Completed. Once marked Completed, choose whether they are Connecting or Not Connecting.
[notifications] => y
[entry_point] =>
[step_due] => stdClass Object
(
[type] => days
[days] => 30
)
[admins] => stdClass Object
(
[0] => stdClass Object
(
[id] => bb7955cc-0333-11e5-bd65-06e37142e2e1
[role] =>
)
)
[id] => 1b2d9759-1314-11e5-bd65-06e37142e2e1
[steps] => stdClass Object
(
)
)
)
)
)
)
[1] => stdClass Object
(
[priority] => 2
[status] =>
[name] => Connected
[description] => Once marked as Completed from here, the person moves from being a New Person to a Church Member.
[instructions] =>
[notifications] =>
[entry_point] =>
[step_due] =>
[admins] => stdClass Object
(
)
[id] => 2cec5d9b-1314-11e5-bd65-06e37142e2e1
[steps] => stdClass Object
(
)
)
[2] => stdClass Object
(
[priority] => 3
[status] =>
[name] => Not Connected
[description] => If a person no longer wants to be contacted and does not want to connect with the church they are added to this step. Only Flow Admins can remove people from this step.
[instructions] => Once marked as Completed, a person moves from New Person to Inactive
[notifications] =>
[entry_point] =>
[step_due] =>
[admins] => stdClass Object
(
)
[id] => 39c21fac-1314-11e5-bd65-06e37142e2e1
[steps] => stdClass Object
(
)
)
)
)
)
Please see our response status codes documentation for details of potential error responses for any API request.