Reference

Enumerations

Every fixed value the API accepts or returns, in one place. Send the code, not the label. Labels are what the portal displays and they change without notice; codes do not.

Project types

The type you choose decides which phases are valid and what priority the project carries when it lands.

Code	Label	Priority
`EMERGENCY_WORKS`	Emergency Works	HIGH
`ENVIRONMENTAL_SPILL_HEALTH_INCIDENT`	Environmental Spill / Health Incident	HIGH
`ACCIDENTAL_DISCOVERY`	Accidental Discovery	HIGH
`LAND_USE_CONSENT`	Land Use Consent	MEDIUM
`SUBDIVISION_CONSENT`	Subdivision Consent	MEDIUM
`DISCHARGE_CONSENT_APPLICATION`	Discharge	MEDIUM
`WATER_TAKE_CONSENT`	Water Take Consent	MEDIUM
`COASTAL_STREAM_CONSENT`	Coastal and/or Stream Consent	MEDIUM
`POLICY_OR_POLICY_CHANGE`	Policy	MEDIUM
`PLAN_CHANGE`	Plan Change	MEDIUM
`DESIGNATIONS_NOTICES_OF_REQUIREMENT`	Designations / Notices of Requirement	MEDIUM
`INFRASTRUCTURE_DEVELOPMENT`	Infrastructure Development	MEDIUM
`ARCHAEOLOGICAL_AUTHORITY`	Archaeological Authority	MEDIUM
`RENEWABLE_ENERGY`	Renewable Energy	MEDIUM
`SITE_WORKS_START`	Site Works Start	LOW
`CULTURAL_MONITORING`	Cultural Monitoring	LOW
`BUILDING_OPENING`	Building Opening	LOW
`TREE_CONSENT`	Tree Consent	LOW
`CONSERVATION`	Conservation	LOW
`SCHEDULED_MAINTENANCE`	Scheduled Maintenance	LOW
`EARTHWORKS`	Earthworks	MEDIUM
`OTHER`	Other	MEDIUM

Project phases

Phases are grouped. A works type only accepts works phases, a consent type only accepts consent phases, and policy types have their own longer sequence. Sending a phase outside the group for the type returns 400.

Code	Label	Valid for
`PRE_START`	Pre-start	works
`WORKS_UNDERWAY`	Works underway	works
`COMPLETE`	Complete	works
`PRE_LODGEMENT`	Pre-lodgement	consent, policy
`LODGED`	Lodged	consent, policy
`FURTHER_INFORMATION_REQUESTED`	Further information requested	consent, policy
`ACCEPTANCE_DECISION`	Acceptance decision	policy
`NOTIFICATION`	Notification	consent, policy
`SUBMISSIONS`	Submissions	consent, policy
`FURTHER_SUBMISSIONS`	Further submissions	policy
`HEARING`	Hearing	consent, policy
`DECISION`	Decision	consent, policy
`APPEAL`	Appeal	consent, policy
`OPERATIVE`	Operative	policy
`ON_HOLD`	On Hold	consent, policy
`WITHDRAWN`	Withdrawn	consent, policy

Project status

Status is set by the platform as the project moves. You do not send it.

Code	Meaning
`DRAFT`	Created, not sent, not billed.
`NEW`	Sent, not yet opened by the iwi.
`AWAITING_RESPONSE`	Picked up on the iwi side, no reply yet.
`IN_PROGRESS`	Kōrero underway.
`UPDATED`	New activity since you last looked.
`COMPLETE`	Engagement finished.
`CLOSED`	Closed off.

Priority

Code	Applies to
`HIGH`	Emergency works, environmental spills and health incidents, accidental discovery.
`MEDIUM`	Consents, policy and plan changes, infrastructure, earthworks, renewable energy, other.
`LOW`	Site works start, cultural monitoring, building openings, tree consents, conservation, scheduled maintenance.

Priority is derived from the type. There is no field to set or override it.

Meeting types

Used on notes to record how an interaction happened.

Code	Label
`PHONE_CALL`	Phone Call
`VIDEO_CALL`	Video Call
`IN_PERSON`	In-person
`EMAIL`	Email
`OTHER`	Other

Log actions and resources

Entries in GET /projects/{id}/logs carry an action and the resource it applied to.

Action	Resource
`CREATED`, `UPDATED`, `DELETED`, `RESPONDED`, `SENT`, `REOPENED`, `CLOSED`, `COMPLETED`	`PROJECT`, `TEAM`

User roles

Code	Can do
`OWNER`	Manage the team, its people and its billing, on top of everything a member can do.
`MEMBER`	Work on projects, notes and groups.

Invitation status

Code	Meaning
`PENDING`	Sent, not yet acted on.
`ACCEPTED`	Accepted. The person is now a member.
`EXPIRED`	Lapsed or cancelled. Resending creates a fresh window.

Upload categories

Code	Accepted extensions
`document`	`.pdf`, `.doc`, `.docx`, `.jpg`, `.jpeg`, `.png`
`image`	`.png`, `.jpg`, `.jpeg`, `.webp`
`gisLayer`	`.geojson`, `.json`, `.kml`, `.zip`, `.topojson`

Bulk invite results

Code	Meaning
`INVITED`	Invitation sent.
`SKIPPED`	Already a member or already invited. Not an error.
`FAILED`	The row could not be processed. See `message`.

New values get added. Project types and phases grow as the platform covers more kinds of work. Treat an unrecognised code as a value you display verbatim rather than something that should crash a parser.