People
Quick add person
POST
/api/v1/people/quick_add
on the Little Outreach JSON API. Send
Authorization: Bearer
or
X-Api-Key
on every request.
Description
Minimal one-call endpoint for adding a person to the directory. Takes a **flat** JSON body
— no `person:` wrapper, no manual `email_addresses_attributes`/`name_aliases_attributes`
nesting.
**Required:** `first_name`, `last_name`, and a citation. The easiest way to supply the
citation is `source_url` (URL only — `source_category` defaults to `internal`). For
richer citations, send a nested `source` / `citation` / `source_reference` object.
**Optional: attach to an organization in the same call.** When `organization_public_id`
is provided, a `Membership` row is created in the same transaction (with `role`
defaulting to `member`) and a citation is attached to both records. The organization
must already exist — create it first with `POST /api/v1/organizations` if needed.
**Optional arrays:** `emails` (strings or `{ address, verified_at }` objects) and
`aliases` / `name_aliases` (strings or `{ name }` objects). For a single email just use
`"email": "ada@example.com"`.
Returns `{ "person": {…}, "membership": {…}? }`. Requires `can_edit`. Costs one credit.
Try & reference
- Open in Swagger UI — this path is pre-selected; use Authorize with your API key.
- People playground — labelled form fields for this resource's most common actions.
- Full-surface playground — send any method to any path.
- OpenAPI YAML — full machine-readable specification.
Quick answers
- How do I call this endpoint?
-
Send
POST /api/v1/people/quick_addto your deployment’s host withAuthorization: BearerorX-Api-Keyset to your API key. - Where can I try it interactively?
- Use Swagger UI (Authorize with your key) or the API playground.