Apis::V4::People API

get person record with email_addresses and interactions

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
organization_ids	comma delimited list of organization ids to scope the items to
include	Comma delimited list of includes desired. Format: ClassName.field
fields	A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

Request

Headers

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

Route

GET /apis/v4/people/29?organization_ids=21&include=email_addresses%2Cinteractions

Query Parameters

organization_ids=21
include=email_addresses,interactions

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.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNzA0NjQ1ODQxLCJpYXQiOjE3MDQ0NzMwNDF9.RmwgHLCymF5SmkwJwYz1wpiL7YZMplVC7NCccjhvsa8
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"43dae43464b000c56956ef11bee50e71"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e2faaf41-b1ed-4ae2-9df7-ce3632d22c9d
X-Runtime: 0.092261
Content-Length: 1518

Status

Body

{
  "data": {
    "id": "29",
    "type": "person",
    "attributes": {
      "created_at": "2024-01-05T16:44:00Z",
      "fb_uid": 0,
      "first_name": "John",
      "full_name": "John Doe",
      "gender": "Male",
      "last_name": "Doe",
      "picture": "https://graph.facebook.com/v2.12/0/picture",
      "updated_at": "2024-01-05T16:44:00Z",
      "relationship_type": null
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "25",
            "type": "email_address"
          }
        ]
      },
      "pathway_progression_audits": {
        "data": []
      },
      "phone_numbers": {
        "data": []
      },
      "user": {
        "data": {
          "id": "19",
          "type": "user"
        }
      },
      "received_challenges": {
        "data": []
      },
      "person_notes": {
        "data": []
      },
      "reverse_contact_assignments": {
        "data": []
      },
      "interactions": {
        "data": [
          {
            "id": "8",
            "type": "interaction"
          }
        ]
      },
      "contact_assignments": {
        "data": []
      },
      "organizational_permissions": {
        "data": [
          {
            "id": "32",
            "type": "organizational_permission"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "25",
      "type": "email_address",
      "attributes": {
        "email": "email_address_email_25@email.com",
        "person_id": "29",
        "primary": true,
        "created_at": "2024-01-05T16:44:00Z",
        "updated_at": "2024-01-05T16:44:00Z"
      }
    },
    {
      "id": "8",
      "type": "interaction",
      "attributes": {
        "created_by_id": "20",
        "interaction_type_name": "Comment Only",
        "interaction_type_notes?": true,
        "interaction_type_id": 1,
        "updated_by_id": "",
        "comment": "interaction_comment_5",
        "privacy_setting": "organization",
        "timestamp": "2024-01-05T16:44:00Z",
        "created_at": "2024-01-05T16:44:00Z"
      },
      "relationships": {
        "initiators": {
          "data": [
            {
              "id": "20",
              "type": "person"
            }
          ]
        },
        "organization": {
          "data": {
            "id": "21",
            "type": "organization"
          }
        },
        "receiver": {
          "data": {
            "id": "29",
            "type": "person"
          }
        },
        "creator": {
          "data": {
            "id": "20",
            "type": "person"
          }
        }
      }
    }
  ]
}