Lists members inside a people flow step
POSThttps://api.elvanto.com/v1/peopleFlows/steps/people.{json|xml|php}
Name | Type | Description |
---|---|---|
step_id Required | string | The UUID of the People Flow Step you wish to list the members of. |
status | string | Status option if wish to filter the people in the step to if desired. Options include
complete , notstarted , pending , inprogress |
assigned | string | Option to filter people to only those assigned to a specific admin by using the UUID
of the admin, or those who are unassigned using unassigned |
{
"step_id": "b63f3064-7be7-4fec-bc9a-1670518ac57f",
"status": "pending",
"assigned": "22af2200-1f5d-4ec1-9d0e-10af7978e3f8"
}
step_id=b63f3064-7be7-4fec-bc9a-1670518ac57f&status=pending&assigned=22af2200-1f5d-4ec1-9d0e-10af7978e3f8
{
"generated_in": "3.02",
"status": "ok",
"people_flow_step_members": {
"on_this_page": 2,
"page": 1,
"per_page": 2,
"total": 2,
"people_flow_step_member": [
{
"member_firstname": "Gary",
"member_preferred_name": "",
"member_middle_name": null,
"member_lastname": "Boyd",
"date_added": "2024-06-10 00 =>08 =>49",
"assigned_admin_id": "",
"status": "pending",
"completed_date": null,
"completed_member": "",
"due_date": "2021-06-12",
"flow_step_member_id": "0e315112-1cdf-4b5a-ac21-216ca3807a3f",
"id": "ae428efc-0333-11e5-bd65-06e37142e2e1"
},
{
"member_firstname": "John",
"member_preferred_name": "",
"member_middle_name": null,
"member_lastname": "Mckenzie",
"date_added": "2021-06-10 00 =>09 =>00",
"assigned_admin_id": "bae2221f-0333-11e5-bd65-06e37142e2e1",
"status": "",
"completed_date": null,
"completed_member": "",
"due_date": "2021-06-12",
"flow_step_member_id": "d7193890-0029-4d14-83db-6384b59c0a0b",
"id": "b6d063a7-0333-11e5-bd65-06e37142e2e1"
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?> <rsp generated_in="3.02" status="ok"> <people_flow_step_members on_this_page="100" page="1" per_page="100" total="154"> <on_this_page>2</on_this_page> <page>1</page> <per_page>2</per_page> <total>2</total> <people_flow_step_member flow_step_member_id="0e315112-1cdf-4b5a-ac21-216ca3807a3f" id="ae428efc-0333-11e5-bd65-06e37142e2e1"> <member_firstname>Gary</member_firstname> <member_preferred_name></member_preferred_name> <member_middle_name></member_middle_name> <member_lastname>Boyd</member_lastname> <date_added>2024-06-10 00 =>08 =>49</date_added> <assigned_admin_id></assigned_admin_id> <status>pending</status> <completed_date></completed_date> <completed_member></completed_member> <due_date>2021-06-12</due_date> </people_flow_step_member> <people_flow_step_member flow_step_member_id="d7193890-0029-4d14-83db-6384b59c0a0b" id="b6d063a7-0333-11e5-bd65-06e37142e2e1"> <member_firstname>John</member_firstname> <member_preferred_name></member_preferred_name> <member_middle_name></member_middle_name> <member_lastname>Mckenzie</member_lastname> <date_added>2021-06-10 00 =>09 =>00</date_added> <assigned_admin_id>bae2221f-0333-11e5-bd65-06e37142e2e1</assigned_admin_id> <status></status> <completed_date></completed_date> <completed_member></completed_member> <due_date>2021-06-12</due_date> </people_flow_step_member> </people_flow_step_members> </rsp>
stdClass Object
(
[generated_in] => 3.02
[status] => ok
[people_flow_step_members] => stdClass Object
(
[on_this_page] => 2
[page] => 1
[per_page] => 2
[total] => 2
[people_flow_step_member] => stdClass Object
(
[0] => stdClass Object
(
[member_firstname] => Gary
[member_preferred_name] =>
[member_middle_name] =>
[member_lastname] => Boyd
[date_added] => 2024-06-10 00 =>08 =>49
[assigned_admin_id] =>
[status] => pending
[completed_date] =>
[completed_member] =>
[due_date] => 2021-06-12
[flow_step_member_id] => 0e315112-1cdf-4b5a-ac21-216ca3807a3f
[id] => ae428efc-0333-11e5-bd65-06e37142e2e1
)
[1] => stdClass Object
(
[member_firstname] => John
[member_preferred_name] =>
[member_middle_name] =>
[member_lastname] => Mckenzie
[date_added] => 2021-06-10 00 =>09 =>00
[assigned_admin_id] => bae2221f-0333-11e5-bd65-06e37142e2e1
[status] =>
[completed_date] =>
[completed_member] =>
[due_date] => 2021-06-12
[flow_step_member_id] => d7193890-0029-4d14-83db-6384b59c0a0b
[id] => b6d063a7-0333-11e5-bd65-06e37142e2e1
)
)
)
)
Please see our response status codes documentation for details of potential error responses for any API request.