== PEOPLE

The People resource is used to list, create, and update personal profiles.

=== Retrieve a person

A `GET` request will retrieve the details of a personal profile.

==== Response fields

include::{snippets}/people-get-example/response-fields.adoc[]

==== Example request

include::{snippets}/people-get-example/http-request.adoc[]

==== Example response

include::{snippets}/people-get-example/http-response.adoc[]

=== Create a person

A `POST` request will create a new personal profile.

==== Request fields

include::{snippets}/people-create-example/request-fields.adoc[]

==== Response fields

include::{snippets}/people-create-example/response-fields.adoc[]

==== Example request

include::{snippets}/people-create-example/http-request.adoc[]

==== Example response

include::{snippets}/people-create-example/http-response.adoc[]

=== Update a person

A `PUT` request will update the details of a personal profile.

==== Request fields

include::{snippets}/people-update-example/request-fields.adoc[]

==== Response fields

include::{snippets}/people-update-example/response-fields.adoc[]

==== Example request

_Please note that partial updates are not supported. That means that you have to supply the complete
list of custom field values. This should not be a problem because the typical workflow is that you
fetch a complete profile, change only some values, and then post the whole profile back to the server._

include::{snippets}/people-update-example/http-request.adoc[]

==== Example response

include::{snippets}/people-update-example/http-response.adoc[]

=== Retrieve a person lookup

A `GET` request will retrieve the details of a person lookup.

==== Response fields

include::{snippets}/people-get-lookup-example/response-fields.adoc[]

==== Example request

include::{snippets}/people-get-lookup-example/http-request.adoc[]

==== Example response

include::{snippets}/people-get-lookup-example/http-response.adoc[]