Apis::V4::PersonFeed API

list user's journey items with a person

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
include	comma delimited relationships you want included in the response in snake_case format
filters	Filter options: - filters[person_id] = 1 (required, the id of the user's person (contact) who's items you want to list) - filters[organization_ids] = 1,null,2 (required, comma delimited list of organization ids to scope the items to, send "null" to filter for data that has no associated organization AKA personal ministry) - filters[starting_at] = '2018-01-01T00:00:00Z' (required, filter items after the starting_at time) - filters[ending_at] = '2018-01-31T23:59:59Z' (required, filter items before the ending_at time) - filters[scope_to_current_user] = [true,false] (defaults to true, scope the items to only those that are associated to the current user, use "true" for the My Journey Feed and "false" for the Survey Contact Journey Feed)

Response Fields

Name	Description	type
data	primary JSON API payload
included	related models (controlled by the include param)
data[attributes][id]	The id is a randomly generated uuid, it has no significance	String
data[relationships][all]	a collection of all the resources from the other relationships, ordered chronologically
data[relationships][interactions]	interactions initiated by the user, received by the given person_id, belonging to the given organization_ids, ordered by created_at
data[relationships][completed_accepted_challenges]	accepted_challenges that are complete, owned by the user, received by the given person_id, and belonging to the given organization_ids, ordered by completed_at
data[relationships][pathway_progression_audits]	pathway_progression_audits assigned to the user, belonging to the given person_id, and belonging to the given organization_ids, ordered by created_at
data[relationships][contact_assignments]	contact_assignments belonging to the given person_id, and belonging to the given organization_ids, ordered by created_at
data[relationships][contact_unassignments]	deprecated

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNzUsImV4cCI6MTcwNDQ3MzIzNSwiaWF0IjoxNzA0NDczMDU1fQ.JTCuTylN2lYPGxSdjM0a0hpFk_f10QIN_TtNe3VefwE
Host: example.org
Cookie:

Route

GET /apis/v4/person_feed?include=*&filters[person_id]=319&filters[organization_ids]=3&filters[starting_at]=2023-12-06T16%3A44%3A15Z&filters[ending_at]=2024-01-05T16%3A44%3A15Z

Query Parameters

include=*
filters={"person_id"=>"319", "organization_ids"=>"3", "starting_at"=>"2023-12-06T16:44:15Z", "ending_at"=>"2024-01-05T16:44:15Z"}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNzUsImV4cCI6MTcwNDY0NTg1NSwiaWF0IjoxNzA0NDczMDU1fQ.pgtwTdeg2VVndO3QI5ZhecHrSFftFMXCjkchnQlkybc
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"36d010f5fcdc93079d29d29161de47e8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c83db817-465a-4aa9-877e-7576f0743700
X-Runtime: 0.110817
Content-Length: 2060

Status

Body

{
  "data": {
    "id": "52cfe621-5899-41cf-b064-48a007a2728b",
    "type": "person_feed",
    "relationships": {
      "all": {
        "data": [
          {
            "id": "70",
            "type": "interaction"
          },
          {
            "id": "63",
            "type": "accepted_challenge"
          },
          {
            "id": "10",
            "type": "pathway_progression_audit"
          }
        ]
      },
      "completed_accepted_challenges": {
        "data": [
          {
            "id": "63",
            "type": "accepted_challenge"
          }
        ]
      },
      "interactions": {
        "data": [
          {
            "id": "70",
            "type": "interaction"
          }
        ]
      },
      "pathway_progression_audits": {
        "data": [
          {
            "id": "10",
            "type": "pathway_progression_audit"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "10",
      "type": "pathway_progression_audit",
      "attributes": {
        "difference": 2,
        "created_at": "2024-01-01T16:44:15Z",
        "updated_at": "2024-01-05T16:44:15Z"
      },
      "relationships": {
        "contact_assignment": {
          "data": {
            "id": "74",
            "type": "contact_assignment"
          }
        },
        "person": {
          "data": {
            "id": "319",
            "type": "person"
          }
        },
        "assigned_to": {
          "data": {
            "id": "318",
            "type": "person"
          }
        },
        "organization": {
          "data": {
            "id": "3",
            "type": "organization"
          }
        },
        "old_pathway_stage": {
          "data": {
            "id": "18",
            "type": "pathway_stage"
          }
        },
        "new_pathway_stage": {
          "data": {
            "id": "19",
            "type": "pathway_stage"
          }
        }
      }
    },
    {
      "id": "63",
      "type": "accepted_challenge",
      "attributes": {
        "title": "Challenge 55",
        "accepted_at": "2024-01-04T16:44:15Z",
        "completed_at": "2024-01-03T16:44:15Z",
        "created_at": "2024-01-05T16:44:15Z",
        "updated_at": "2024-01-05T16:44:15Z",
        "notified_at": null,
        "note": null,
        "focus": false,
        "deleted_at": null
      },
      "relationships": {
        "owner": {
          "data": {
            "id": "318",
            "type": "person"
          }
        },
        "receiver": {
          "data": {
            "id": "319",
            "type": "person"
          }
        },
        "challenge_suggestion": {
          "data": null
        },
        "reminder": {
          "data": null
        },
        "organization": {
          "data": {
            "id": "3",
            "type": "organization"
          }
        }
      }
    },
    {
      "id": "70",
      "type": "interaction",
      "attributes": {
        "created_by_id": "320",
        "interaction_type_name": "Comment Only",
        "interaction_type_notes?": true,
        "interaction_type_id": 1,
        "updated_by_id": "",
        "comment": "interaction_comment_64",
        "privacy_setting": "organization",
        "timestamp": "2024-01-04T16:44:15Z",
        "created_at": "2024-01-04T16:44:15Z"
      },
      "relationships": {
        "initiators": {
          "data": [
            {
              "id": "318",
              "type": "person"
            }
          ]
        },
        "organization": {
          "data": {
            "id": "3",
            "type": "organization"
          }
        },
        "receiver": {
          "data": {
            "id": "319",
            "type": "person"
          }
        },
        "creator": {
          "data": {
            "id": "320",
            "type": "person"
          }
        }
      }
    }
  ]
}