Organizations
Quick add organization
POST
/api/v1/organizations/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 an organization to the directory. Takes a **flat**
JSON body — no `organization:` wrapper, no manual `email_addresses_attributes` /
`name_aliases_attributes` nesting.
**Required:** `name`, `domain`, `organization_type`, 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 a first member in the same call.** Supply a nested `person` block with
`first_name` + `last_name` and, optionally, `email`, `role`, `title`, `start_date`. When
present, a Person and Membership are created in the same transaction and each record gets
its own citation copy.
**Optional arrays:** `aliases` / `name_aliases` and `emails` accept either strings or
`{ address, verified_at }` / `{ name }` objects.
Returns `{ "organization": {…}, "person": {…}?, "membership": {…}? }`. Requires
`can_edit`. Costs one credit (plus one each for the optional person and membership).
Try & reference
- Open in Swagger UI — this path is pre-selected; use Authorize with your API key.
- Organizations 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/organizations/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.