Deals

Deals

Deals in de pipeline ophalen, aanmaken, bijwerken en verplaatsen. Scope: deals.read / deals.write.

Deals ophalen

GET /v1/deals
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
page integer
per_page integer
client_id string
status string Filter by deal status (`open`, `won`, or `lost`).
pipeline_id string
phase_id string
Request body

Geen

Response
data array
id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object
page integer
per_page integer
total integer
pages integer

Examples

GET /v1/deals
curl -X GET "https://api.appficient.nl/v1/deals" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Deal aanmaken

POST /v1/deals
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Headers
Naam Type Beschrijving
Idempotency-Key string Optional. Replay within 24h returns the same response.
Request body
title string Required
client_id string Required
pipeline_id string
phase_id string
amount string
priority string

Default `medium`.

Enum
low medium high
Example: medium
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
expected_close_date string
Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

POST /v1/deals
curl -X POST "https://api.appficient.nl/v1/deals" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "string",
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "pipeline_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "phase_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": "string",
    "priority": "medium",
    "status": "open",
    "expected_close_date": "2026-07-01"
}'

Curl, Node en response staan rechts naast dit endpoint.

Deal ophalen

GET /v1/deals/{id}
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Request body

Geen

Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

GET /v1/deals/{id}
curl -X GET "https://api.appficient.nl/v1/deals/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Deal bijwerken

PATCH /v1/deals/{id}
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Request body
title string
client_id string
pipeline_id string
phase_id string
amount string
priority string

Default `medium`.

Enum
low medium high
Example: medium
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
expected_close_date string
Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

PATCH /v1/deals/{id}
curl -X PATCH "https://api.appficient.nl/v1/deals/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "string",
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "pipeline_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "phase_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": "string",
    "priority": "medium",
    "status": "open",
    "expected_close_date": "2026-07-01"
}'

Curl, Node en response staan rechts naast dit endpoint.

Deal verwijderen

DELETE /v1/deals/{id}
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Request body

Geen

Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

DELETE /v1/deals/{id}
curl -X DELETE "https://api.appficient.nl/v1/deals/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Deal verplaatsen

POST /v1/deals/{id}/move
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Headers
Naam Type Beschrijving
Idempotency-Key string Optional. Replay within 24h returns the same response.
Request body
phase_id string
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

POST /v1/deals/{id}/move
curl -X POST "https://api.appficient.nl/v1/deals/{id}/move" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "phase_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "open"
}'

Curl, Node en response staan rechts naast dit endpoint.

Deal als gewonnen markeren

POST /v1/deals/{id}/win
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Request body

Geen

Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

POST /v1/deals/{id}/win
curl -X POST "https://api.appficient.nl/v1/deals/{id}/win" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Deal als verloren markeren

POST /v1/deals/{id}/lose
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string
Request body

Geen

Response
data object

Deal.

id string
title string
amount number
status string

`open`, `won`, or `lost`.

Enum
open won lost
Example: open
priority string

Default `medium`.

Enum
low medium high
Example: medium
pipeline_id string
phase_id string
client_id string
expected_close_date string
created_at string
meta object

Examples

POST /v1/deals/{id}/lose
curl -X POST "https://api.appficient.nl/v1/deals/{id}/lose" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Dealbronnen ophalen

GET /v1/deal-sources

Each item has `name` and `order`

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Request body

Geen

Response
data array
name string
order integer
meta object

Examples

GET /v1/deal-sources
curl -X GET "https://api.appficient.nl/v1/deal-sources" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Phases ophalen

GET /v1/phases

Optional `pipeline_id`

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
pipeline_id string Filter phases by pipeline id
Request body

Geen

Response
data array
id string
pipeline_id string
name string
order integer
meta object

Examples

GET /v1/phases
curl -X GET "https://api.appficient.nl/v1/phases" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Pipelines ophalen

GET /v1/pipelines

Includes nested phases

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Request body

Geen

Response
data array
id string
name string
active boolean
phases array
id string
name string
order integer
meta object

Examples

GET /v1/pipelines
curl -X GET "https://api.appficient.nl/v1/pipelines" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.