Search and list constituents

GET

/api/constituents

const url = 'https://example.com/api/constituents';
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 \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Query Parameters

query

string

Responses

200

A list of constituents

application/json

Array<object>

object

required

Unique identifier (UUID v4) for the resource.

string format: uuid

householdId

required

UUID (v4) of the constituent household group.

string format: uuid

firstName

First or given name.

string

nullable

lastName

Last or family name.

string

nullable

phone

E.164 formatted contact phone number.

string

nullable

email

Primary email address.

string

nullable

addressStreet

Physical street address line.

string

nullable

addressCity

City or municipality name.

string

nullable

addressState

Two-letter US state abbreviation.

string

nullable

addressZip

5-digit US ZIP postal code.

string

nullable

dateOfBirth

Date of birth formatted as YYYY-MM-DD.

string format: date

nullable

Example

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
    "householdId": "50000000-0000-0000-0000-000000000005",
    "firstName": "Sarah",
    "lastName": "Jenkins",
    "phone": "+17045550199",
    "email": "[email protected]",
    "addressStreet": "456 Oak Avenue",
    "addressCity": "Concord",
    "addressState": "NC",
    "addressZip": "28025",
    "dateOfBirth": "1988-04-15"
  }
]

401

Unauthorized

403

Forbidden