List all path journeys in a nation
Changed onLists all path journeys
Request
- Base URLhttps://yournation.nationbuilder.com
- AuthHTTP bearer
Query parameters
Page number to list (starting at 1)
Number of results to display per page (default: 20, max: 100, min: 1)
Response
A page of matching path journeys.
Example response
{
"data": [
{
"id": "1",
"type": "path_journeys",
"attributes": {
"current_step_due_date": "2019-10-26T10:00:00-04:00",
"current_step_id": "1",
"current_step_point_person_id": "1",
"description": "Added by API",
"due_date": "2019-10-26T10:00:00-04:00",
"path_id": "1",
"point_person_id": "1",
"signup_id": "1",
"value_amount": "5.00",
"created_at": "2019-10-26T10:00:00-04:00",
"ended_at": "2019-10-26T10:00:00-04:00",
"journey_status": "active",
"last_moved_at": "2019-10-26T10:00:00-04:00",
"path_journey_status_change_id": "1",
"updated_at": "2019-10-26T10:00:00-04:00"
}
}
],
"links": {
"self": "/articles?page[number]=2",
"first": "/articles?page[number]=1",
"last": "/articles?page[number]=5",
"prev": "/articles?page[number]=1",
"next": "/articles?page[number]=3"
},
"included": [
{
"id": "1"
}
]
}Changes
- breaking
for the
queryrequest parameterpage[number], default value1was added - breaking
for the
queryrequest parameterpage[size], default value20was added - breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - info
added
subschema #2to the response bodyallOflist for the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- breaking