peopleFlows/steps/people

Lists members inside a people flow step

POST
https://api.elvanto.com/v1/peopleFlows/steps/people.{json|xml|php}

Notes

  • No pagination for this endpoint

Parameters

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
Expected request JSON HTTP POST
{
    "step_id": "b63f3064-7be7-4fec-bc9a-1670518ac57f",
    "status": "pending",
    "assigned": "22af2200-1f5d-4ec1-9d0e-10af7978e3f8"
}
Expected response JSON XML PHP
{
    "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"
            }
        ]
    }
}
Error responses

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: The "step_id" parameter is required. A People Flow Step must be provided for the person to be added into.
  • 250: The "step_id" parameter is invalid. The People Flow Step UUID provided is not a valid UUID, or does not correspond to a People Flow Step in the system
  • 250: The "status" parameter is invalid. The Status option provided is not valid
  • 250: The "assigned" parameter is invalid. Assigned option provided is not valid. Either provide a UUID of a member or use unassigned