ProLine Partner API (1.0)

Pages through every project in the company, newest first, with its stage, contacts, budget figures and status dates. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative. project_notes is returned as plain text.

Response shape: direct (see Overview → Response shapes).

Looks up one project and returns the first match. The keys are tried in this order: project_id, then project_external_id, then contact_id (the first project whose main contact is that contact), then the address fields together. project_stage and project_status do not find a project on their own; they filter the one that was found, so a project in another stage or status answers [].

body is an array with one project, or an empty array when nothing matched (there is no not-found error). An id that does not resolve, in the lookup or in a filter, also answers [].

Response shape: wrapped (see Overview → Response shapes).

Updates an existing project and its main contact, or creates both, in one call, and optionally schedules an event on the project.

Create or update is decided in this order: project_id; otherwise the one project whose external_id matches (two or more matches are rejected, send project_id); otherwise, when edit_contact_latest is true, the contact's newest open project; otherwise a new project is created. external_id_new renames the external id and is refused when another project holds it.

The contact is resolved by contact_id, then contact_phone, then contact_email, then the existing project's main contact, then an unsaved draft with that phone; otherwise a contact is created, which requires contact_fname or contact_name.

Omitted or blank fields are left unchanged on both the project and the contact, so a value cannot be cleared through this endpoint. The one exception is project_tags: when present it replaces the whole tag list, and "" or [] clears it. A new project with no project_stage goes into the first stage of the first project pipeline. Ids that do not resolve (project_assign, project_category, project_location, ...) are dropped and the call still succeeds.

Side effects: a contact may be created, default folders are created on a new project, field changes are logged as activities and project webhooks fire. An event scheduling failure never fails the call; event_scheduled is then "null". An event_external_id held by an event on another project is skipped.

Rejections arrive inside body.response with error: true (the outer status is still "success"). When the company's automations are paused, body is { "ok": true } and nothing is written.

Response shape: wrapped (see Overview → Response shapes).

Returns the stages of the company's project pipelines, grouped by pipeline in pipeline order. The id is what /v1/find/project returns as stage_id, and what project_stage takes on /v1/edit/project (/v1/list/projects returns the stage name only). Archived stages are not listed.

Response shape: direct (see Overview → Response shapes).

Pages through every job in the company, newest first, with its project, service and stage. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative. job_description is returned as plain text.

Response shape: direct (see Overview → Response shapes).

Looks up one contact by id, phone, email or address and returns the first match. The keys are tried in that order: contact_id, then contact_phone, then contact_email, then the address fields together; the first key that matches wins and the rest are not consulted. Archived contacts and contacts of other companies are not matched.

body is an array with one contact, or an empty array when nothing matched (there is no not-found error). An empty request body returns the empty array.

Response shape: wrapped (see Overview → Response shapes).

Updates an existing contact, or creates one when no match is found. The contact is matched by contact_id first; otherwise by contact_phone, against the newest saved contact with the same number, then against an unsaved draft with that number (the draft becomes the contact); otherwise a new contact is created, which requires contact_fname.

Omitted or blank fields are left unchanged, so a value cannot be cleared through this endpoint. external_id is stored on create only and ignored on update.

Side effects: field changes are logged as activities, the company's contact webhooks fire, lead-source attribution on the contact's projects is synced, and a new contact is given the next contact number.

Rejections arrive inside body.response with error: true (the outer status is still "success"): a missing first name on create, a phone number already held by another contact (that contact's id is returned), and others. When the company's automations are paused, body is { "ok": true } and nothing is written.

Response shape: wrapped (see Overview → Response shapes).

Pages through the company's quotes, newest first, with the project and contact each belongs to, its sent and signed timestamps, totals and deposit terms. Archived quotes are left out and are not counted in total. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative.

Response shape: direct (see Overview → Response shapes).

Pages through the company's orders (purchase and work orders), newest first, with the project, quote, job and vendor each belongs to and its signing status and dates. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative. order_notes is returned as plain text.

Response shape: direct (see Overview → Response shapes).

Pages through the company's invoices, newest first, with totals, balance, status dates and the billing, project and rep details captured on each. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative.

Response shape: direct (see Overview → Response shapes).

Pages through the company's payments, newest first, with the project and invoice each applies to, its status, method and amounts. Filter by creation date with created_after / created_before (both inclusive). Pages are limited to 100 rows and to an offset of 10,000 rows; beyond that, or when a page would read more than the per-call budget, the call answers 400 with a { "status": "error", "message": "..." } body and you should narrow the date window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative.

Response shape: direct (see Overview → Response shapes).

Returns the open appointment start times for one or more team members between start_date and end_date, one row per team member. Start times come back as a single comma-separated string in the time zone of the company's default location, with no UTC offset. The window may span at most 30 days.

The dates are read as UTC when they carry no offset. When user_id, start_date or end_date is missing, body is [{ "start_times": "" }] rather than an error. A window over 30 days, or a calendar that could not be read, answers a { "status": "...", "error": true } object in body; an unknown team member, event type or date format answers the backend validation error in body. When the company's automations are paused, body is { "ok": true }.

Response shape: wrapped (see Overview → Response shapes).

Reschedules an existing event, or creates one on a project. When event_id names a live event it is updated; otherwise a new event is created, which requires project_id.

start_date is required on every call. The end time is derived from the event type's default duration. The event type is event_type, else the existing event's type, else the company's first event type; the calendar is the existing event's, else the type's default, else the company's first calendar. The event title is always set to the event type name.

Omitted or blank fields are left unchanged, so a value cannot be cleared through this endpoint. An assignee that does not resolve is dropped and the existing assignee kept.

Side effects: a new event gets the project's main-contact email as a participant; event webhooks fire. A missing or unparseable start_date, or a company with no event types, answers the backend validation error in body. Creating without project_id, or with no calendar available, answers a { "status": "...", "error": true } object in body. When the company's automations are paused, body is { "ok": true } and nothing is written.

Response shape: wrapped (see Overview → Response shapes).

Cancels the event named by event_id. The event is marked cancelled, not deleted; /v1/find/event still returns it by event_id or external_id, with cancelled: true. Cancelling an already cancelled event runs the cancellation again and answers success. An event that came from an external calendar cannot be cancelled here; the call fails inside body.

A missing or unknown event_id answers { "status": "No existing event found.", "error": true } in body. When the company's automations are paused, body is { "ok": true } and nothing is written.

Response shape: wrapped (see Overview → Response shapes).

Looks up one event and returns the first match. The keys are tried in this order:

1. event_id: exact lookup; a cancelled event is returned, with cancelled: true.
2. external_id: exact lookup; a cancelled event is returned.
3. project_id: the first live event on that project, within the day of start_date when given, otherwise within the next 365 days. event_type and assignee narrow the search.
4. start_date alone: the first live event on that day, with the same filters, and only for days from today on.

Exact lookups ignore the filters. Date searches skip cancelled events. start_date on the two date searches is read as a plain date; the day window is taken in the server's clock, so an event near midnight may fall on the neighbouring day.

body is an array with one event, or an empty array when nothing matched (there is no not-found error). A project_id, event_type or assignee that does not resolve answers [].

Response shape: wrapped (see Overview → Response shapes).

Returns every event type in the company, the default type first and the rest by name A to Z. There is no paging and no envelope. name and label carry the same value. The id is what event endpoints take as the event type.

Response shape: direct (see Overview → Response shapes).

Pages through the activity feed of one project, contact or organization, newest first, optionally restricted to a set of activity types. Exactly one of project_id, contact_id or org_id is required. A parent that does not exist in the company gives an empty page with total: 0, not an error. Filter by creation date with created_after / created_before (both inclusive).

Each call may read at most about 12,000 activity records or 10 MB; when a page cannot be served within that, or the offset is past 10,000 rows, the call answers 400 with a { "status": "error", "message": "..." } body. For a project or organization the whole feed is read and the date window applied afterwards, so on a very busy project reduce limit as well as narrowing the window. total is exact up to 4,000 matching rows and a lower bound past that; has_more is authoritative.

Call rows omit the transcript segments; /v1/find/activity returns them. Ids on activities of migrated companies may be legacy ids (see Overview → Identifiers).

Response shape: direct (see Overview → Response shapes).

Returns one activity by id, in the same shape as a /v1/list/activities row. For a call activity the transcript segments are included under call.transcript. The id may be a ProLine id or a legacy id.

When no activity with that id is visible to the company the call still answers 200, with an empty array [] as the body, not 404. An activity whose detail is larger than the response limit answers 400.

Response shape: direct (see Overview → Response shapes).

Creates an "alert" activity, titled alert_text, on a contact and/or a project. At least one of contact_id or project_id is required. One activity is created per project involved: the project you name plus the project linked to the contact, so a contact with a linked project yields two. A contact with no project gets a single contact-only activity. Nothing is deduplicated.

The answer's activity_created is the number of activities created, as a string; it is not an id (the call and message endpoints return an id under the same key).

Response shape: wrapped (see Overview → Response shapes).