Bumuo sa ibabaw ng tarsiflow gamit ang simpleng REST API

Account

Kung kanino ang token, ang workspace kung saan ito gumagana, ang mga miyembro nito at ang mga yugto ng pipeline.

• GET /me Ang may-ari ng token, ang workspace at ang mga pahintulot ng token.
• GET /members Mga tao sa workspace, para sa id ng may-hawak at may-ari.
• GET /lead-stages Mga yugto ng pipeline, para sa lead_stage_id.

Mga kliyente

Bawat kliyente sa workspace kasama ang pangunahing contact nito.

• GET /clients Ilista ang mga kliyente. Mga filter: search, status, tag.
• POST /clients Gumawa ng kliyente.
• GET /clients/{id} Kunin ang isang kliyente.
• PATCH /clients/{id} I-update ang kliyente. Ipadala lang ang mga field na binago mo.

Mga field na puwede mong ipadala

name

string

Kailangan kapag gumagawa.

status

string

active, inactive, archived

email, phone, website, address

string

Opsyonal na contact details.

currency

string

Code na may tatlong letra, gaya ng USD. Default ang currency ng workspace.

tags

array

Listahan ng maiikling label.

Halimbawa

curl -X POST https://tarsiflow.com/api/v1/clients \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"name":"Brightline Dental","email":"[email protected]","tags":["healthcare"]}'

{
    "data": {
        "id": 42,
        "name": "Brightline Dental",
        "status": "active",
        "email": "[email protected]",
        "currency": "USD",
        "tags": [
            "healthcare"
        ],
        "primary_contact": null
    }
}

Mga lead

Mga oportunidad sa pipeline mo. Nasa sentimo ang mga halaga.

• GET /leads Ilista ang mga lead. Mga filter: stage_id, search.
• POST /leads Gumawa ng lead. Mapupunta ito sa unang bukas na yugto maliban kung ibibigay mo ang lead_stage_id.
• GET /leads/{id} Kunin ang isang lead.
• PATCH /leads/{id} I-update ang lead, kasama ang paglipat nito sa ibang yugto.

Mga field na puwede mong ipadala

name

string

Kailangan kapag gumagawa. Ang proyekto o tao, gaya ng Website redesign.

company, email, phone, source, notes

string

Opsyonal na detalye.

value_cents

integer

Tantyang halaga sa sentimo. Ang 250000 ay 2,500.00.

expected_close_date

date

YYYY-MM-DD

lead_stage_id, owner_id

integer

Mga id mula sa /lead-stages at /members.

Mga proyekto

Mga proyekto ng kliyente. Awtomatikong nagkakaroon ng unang task list ang mga bagong proyekto.

• GET /projects Ilista ang mga proyekto. Mga filter: client_id, status.
• POST /projects Gumawa ng proyekto para sa isang kliyente.
• GET /projects/{id} Kunin ang isang proyekto kasama ang mga task list nito.
• PATCH /projects/{id} I-update ang proyekto.

Mga field na puwede mong ipadala

client_id, name

kailangan

Ang kliyenteng may-ari nito at ang pangalan nito.

status

string

planning, active, on_hold, completed, cancelled

start_date, due_date

date

YYYY-MM-DD

budget_cents

integer

Budget sa sentimo.

Mga gawain

Mga gawain sa loob ng proyekto, o mag-isa. Naaabisuhan ang tao kapag binigyan ng gawain.

• GET /tasks Ilista ang mga gawain. Mga filter: project_id, assignee_id, status, due_before.
• POST /tasks Gumawa ng gawain.
• GET /tasks/{id} Kunin ang isang gawain.
• PATCH /tasks/{id} I-update ang gawain. Kapag ginawang done ang status, naitatala ang oras ng pagkatapos.

Mga field na puwede mong ipadala

title

string

Kailangan kapag gumagawa.

project_id, task_list_id

integer

Opsyonal. Kung walang list, mapupunta ang gawain sa unang list ng proyekto.

assignee_id

integer

Isang id mula sa /members.

status

string

todo, in_progress, review, done

priority

string

low, medium, high

due_date

date

YYYY-MM-DD

Halimbawa

curl -X PATCH https://tarsiflow.com/api/v1/tasks/318 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"status":"done"}'

{
    "data": {
        "id": 318,
        "title": "Homepage wireframes",
        "status": "done",
        "priority": "high",
        "completed_at": "2026-10-26T14:05:11+00:00"
    }
}

Mga invoice

Read only. Kasama sa endpoint ng isang invoice ang mga line item at bayad.

• GET /invoices Ilista ang mga invoice. Mga filter: status, client_id.
• GET /invoices/{id} Kunin ang isang invoice kasama ang mga item, bayad at natitirang babayaran.

Mga proposal

Read only. Kasama sa endpoint ng isang proposal ang mga line item.

• GET /proposals Ilista ang mga proposal. Mga filter: status, client_id.
• GET /proposals/{id} Kunin ang isang proposal kasama ang mga line item nito.