# Marro

> How to connect to and use Marro.

- [Introduction](https://docs.marro.si/index.md): How to connect to and use Marro.
- [Getting started](https://docs.marro.si/getting-started.md): Create an API key and make your first request.
- [Authentication](https://docs.marro.si/authentication.md): Send your key as a bearer token, over HTTPS, from your server.
- [Keys and scopes](https://docs.marro.si/keys-and-scopes.md): What each scope allows, and how to rotate and revoke keys.
- [Connect a website](https://docs.marro.si/guides/connect-a-website.md): Send your website's form enquiries into Marro as leads.
- [Filtering leads](https://docs.marro.si/guides/filtering.md): Find leads by any field.
- [Errors](https://docs.marro.si/errors.md): Error format and every error code the API returns.
- [Rate limits](https://docs.marro.si/rate-limits.md): How many requests a key and an organization can make.
- [List leads](https://docs.marro.si/api-reference/leads/list-leads.md): Leads in the organization, newest first, a page at a time. Filter by stage, source, owner, time of last change, or any field. Archived leads are left out.
- [Create a lead](https://docs.marro.si/api-reference/leads/create-lead.md): Creates a lead with the organization’s own field rules: required fields, option lists and formats are checked exactly as in the app. The lead starts in the starting stage unless you give one, and without an owner the organization’s assignment rules pick one. Phone number and email are unique per org…
- [Capture a lead](https://docs.marro.si/api-reference/leads/capture-lead.md): For website and landing-page forms. Adds the enquiry as a new lead, or, when the organization already has a lead with this phone number or email, fills in that lead instead: only fields it has empty are filled, and values that differ from what a counsellor entered are kept and listed on the lead’s t…
- [Get a lead](https://docs.marro.si/api-reference/leads/get-lead.md): One lead with every field.
- [Update a lead](https://docs.marro.si/api-reference/leads/update-lead.md): Changes only the fields you send, checked with the organization’s field rules, and optionally the stage or the pipeline (`pipelineId`, with `stageId` for where in it). Every change is recorded on the lead’s timeline as made via the API.
- [Add a note](https://docs.marro.si/api-reference/leads/add-note.md): Adds a note to the lead’s timeline, shown as added via the API.
- [List lead fields](https://docs.marro.si/api-reference/reference/list-fields.md): The organization’s active lead fields, its own custom fields included: their keys, types, options and whether each is required. Use the keys in `fields` when reading, writing and capturing leads. A `leads.capture` key may read this list too, to build a form. Fields an organization adds later appear…
- [List stages](https://docs.marro.si/api-reference/reference/list-stages.md): Active stages of every pipeline, each pipeline’s in order, with what each means (open, won or lost), which one its new leads start in, and the pipeline it belongs to.
- [List pipelines](https://docs.marro.si/api-reference/reference/list-pipelines.md): The organization’s pipelines in order: separate tracks for leads, each with its own stages. New leads go into the default one unless a `pipelineId` or a stage of another pipeline is given.
- [List sources](https://docs.marro.si/api-reference/reference/list-sources.md): Active lead sources. Send an ID as the `source` field when creating or updating a lead.
- [List people](https://docs.marro.si/api-reference/reference/list-users.md): Active people in the organization, to read lead owners and to send `assigned_to`. Names only; no contact details.
- [List leads](https://docs.marro.si/api-reference/leads/list-leads.md): Leads in the organization, newest first, a page at a time. Filter by stage, source, owner, time of last change, or any field. Archived leads are left out.
- [Create a lead](https://docs.marro.si/api-reference/leads/create-a-lead.md): Creates a lead with the organization’s own field rules: required fields, option lists and formats are checked exactly as in the app. The lead starts in the starting stage unless you give one, and without an owner the organization’s assignment rules pick one. Phone number and email are unique per org…
- [Capture a lead](https://docs.marro.si/api-reference/leads/capture-a-lead.md): For website and landing-page forms. Adds the enquiry as a new lead, or, when the organization already has a lead with this phone number or email, fills in that lead instead: only fields it has empty are filled, and values that differ from what a counsellor entered are kept and listed on the lead’s t…
- [Get a lead](https://docs.marro.si/api-reference/leads/get-a-lead.md): One lead with every field.
- [Update a lead](https://docs.marro.si/api-reference/leads/update-a-lead.md): Changes only the fields you send, checked with the organization’s field rules, and optionally the stage or the pipeline (`pipelineId`, with `stageId` for where in it). Every change is recorded on the lead’s timeline as made via the API.
- [Add a note](https://docs.marro.si/api-reference/leads/add-a-note.md): Adds a note to the lead’s timeline, shown as added via the API.
- [List lead fields](https://docs.marro.si/api-reference/reference/list-lead-fields.md): The organization’s active lead fields, its own custom fields included: their keys, types, options and whether each is required. Use the keys in `fields` when reading, writing and capturing leads. A `leads.capture` key may read this list too, to build a form. Fields an organization adds later appear…
- [List stages](https://docs.marro.si/api-reference/reference/list-stages.md): Active stages of every pipeline, each pipeline’s in order, with what each means (open, won or lost), which one its new leads start in, and the pipeline it belongs to.
- [List pipelines](https://docs.marro.si/api-reference/reference/list-pipelines.md): The organization’s pipelines in order: separate tracks for leads, each with its own stages. New leads go into the default one unless a `pipelineId` or a stage of another pipeline is given.
- [List sources](https://docs.marro.si/api-reference/reference/list-sources.md): Active lead sources. Send an ID as the `source` field when creating or updating a lead.
- [List people](https://docs.marro.si/api-reference/reference/list-people.md): Active people in the organization, to read lead owners and to send `assigned_to`. Names only; no contact details.

## OpenAPI Specs

- [openapi](/openapi.json)