Retrieve demographic revision history for a constituent

GET

/api/constituents/{id}/demographics/history

const url = 'https://example.com/api/constituents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/demographics/history';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/constituents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/demographics/history \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

List of demographic revisions and diffs

application/json

Array<object>

object

required

string format: uuid

organizationId

required

string format: uuid

constituentId

required

string format: uuid

needId

string format: uuid

nullable

recordedBy

string format: uuid

nullable

sourceChannel

required

string

reason

required

string

snapshot

required

Full demographic snapshot at the time of recording.

object

changes

required

Field-level diffs from previous revision.

object

createdAt

required

string format: date-time

Example

[
  {
    "sourceChannel": "web_form",
    "reason": "annual_recertification"
  }
]

401

Unauthorized

403

Forbidden

404

Constituent not found