Skip to main content
POST
Create household

Authorizations

Authorization
string
header
required

Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.

Headers

X-Organization-Id
string

Required with OAuth access tokens. Optional with organization API keys; if supplied, it must match the key's organization.

Body

application/json
name
string
required
Example:

"Johnson Family"

primaryContactId
string | null
Example:

"cm456def789ghi"

externalIds
object | null

Response

Created household

Household detail with a compact member collection, normalized external IDs, primary contact, and live giving aggregates.

id
string
name
string
primaryContactId
string | null
primaryContact
object | null

Compact donor identity, household, membership, and giving summary used in list and relationship responses.

externalIds
object[]
members
object[]
aggregates
object
createdAt
string<date-time>
updatedAt
string<date-time>
Last modified on August 23, 2026