Apis::V4::People API

get non-organization person

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.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNzA0NDczMjIxLCJpYXQiOjE3MDQ0NzMwNDF9.c4C7eYzPl5M3mDhgK4d-L8FnNWUlcLa3h67qvLQpg4c
Host: example.org
Cookie:

Route

GET /apis/v4/people/35?organization_ids=26&include=*

Query Parameters

organization_ids=26
include=*

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/"bbd4780d7731bf4c906090392723c26d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 03dfa92d-ad5b-4a52-9da3-50e5818c0f5a
X-Runtime: 0.086817
Content-Length: 1685

Status

Body

{
  "data": {
    "id": "35",
    "type": "person",
    "attributes": {
      "created_at": "2024-01-05T16:44:01Z",
      "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:01Z",
      "relationship_type": null
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "30",
            "type": "email_address"
          }
        ]
      },
      "pathway_progression_audits": {
        "data": []
      },
      "phone_numbers": {
        "data": [
          {
            "id": "1",
            "type": "phone_number"
          }
        ]
      },
      "user": {
        "data": {
          "id": "24",
          "type": "user"
        }
      },
      "received_challenges": {
        "data": []
      },
      "person_notes": {
        "data": []
      },
      "reverse_contact_assignments": {
        "data": [
          {
            "id": "10",
            "type": "contact_assignment"
          }
        ]
      },
      "interactions": {
        "data": []
      },
      "contact_assignments": {
        "data": []
      },
      "organizational_permissions": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "30",
      "type": "email_address",
      "attributes": {
        "email": "email_address_email_30@email.com",
        "person_id": "35",
        "primary": true,
        "created_at": "2024-01-05T16:44:01Z",
        "updated_at": "2024-01-05T16:44:01Z"
      }
    },
    {
      "id": "1",
      "type": "phone_number",
      "attributes": {
        "number": "4938444593",
        "person_id": "35",
        "location": "mobile",
        "primary": true,
        "not_mobile": false,
        "validated": false,
        "created_at": "2024-01-05T16:44:01Z",
        "updated_at": "2024-01-05T16:44:01Z"
      }
    },
    {
      "id": "24",
      "type": "user",
      "attributes": {
        "username": "email_address_email_30@email.com",
        "created_at": "2024-01-05T16:44:01Z",
        "updated_at": "2024-01-05T16:44:01Z",
        "last_sign_in_at": null
      }
    },
    {
      "id": "10",
      "type": "contact_assignment",
      "attributes": {
        "person_id": "35",
        "created_at": "2024-01-05T16:44:01Z",
        "pathway_stage_id": ""
      },
      "relationships": {
        "person": {
          "data": {
            "id": "35",
            "type": "person"
          }
        },
        "assigned_to": {
          "data": {
            "id": "20",
            "type": "person"
          }
        },
        "assigned_by": {
          "data": null
        },
        "organization": {
          "data": null
        }
      }
    }
  ]
}