Tickets

Tickets

Tickets and messages. Priority: low, normal, high, urgent (invalid → normal). Scope: tickets.read / tickets.write.

List tickets

GET /v1/tickets
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Name Type Description
page integer
per_page integer
search string
Request body

None

Response
data array
id string
number string
subject string
status string

Status name.

priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string Nullable
project_id string Nullable
created_at string
meta object
page integer
per_page integer
total integer
pages integer

Examples

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

Curl, Node and response are shown to the right of this endpoint.

Create a ticket

POST /v1/tickets
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Headers
Name Type Description
Idempotency-Key string Optional. Replay within 24h returns the same response.
Request body
subject string Required
priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string
Response
data object

Ticket.

id string
number string
subject string
status string

Status name.

priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string Nullable
project_id string Nullable
created_at string
source string
Example: api
updated_at string
closed_at string Nullable
meta object

Examples

POST /v1/tickets
curl -X POST "https://api.appficient.nl/v1/tickets" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "string",
    "priority": "normal",
    "client_name": "string",
    "client_email": "string",
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'

Curl, Node and response are shown to the right of this endpoint.

Retrieve a ticket

GET /v1/tickets/{id}
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Name Type Description
id Required string
Request body

None

Response
data object

Ticket.

id string
number string
subject string
status string

Status name.

priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string Nullable
project_id string Nullable
created_at string
source string
Example: api
updated_at string
closed_at string Nullable
meta object

Examples

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

Curl, Node and response are shown to the right of this endpoint.

Update a ticket

PATCH /v1/tickets/{id}

Send at least one field

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Name Type Description
id Required string
Request body
subject string
priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string
Response
data object

Ticket.

id string
number string
subject string
status string

Status name.

priority string

Unknown values become `normal`.

Enum
low normal high urgent
Example: normal
client_name string
client_email string
client_id string Nullable
project_id string Nullable
created_at string
source string
Example: api
updated_at string
closed_at string Nullable
meta object

Examples

PATCH /v1/tickets/{id}
curl -X PATCH "https://api.appficient.nl/v1/tickets/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "string",
    "priority": "normal",
    "client_name": "string",
    "client_email": "string",
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'

Curl, Node and response are shown to the right of this endpoint.

List messages for a ticket

GET /v1/tickets/{id}/messages

Not paginated

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Name Type Description
id Required string
Request body

None

Response
data array
id string
direction string

API creates are always `out`.

Enum
in out
type string
Enum
reply note
Example: note
body string
created_at string
author object
name string
email string
meta object

Examples

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

Curl, Node and response are shown to the right of this endpoint.

Create a ticket message

POST /v1/tickets/{id}/messages
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Name Type Description
id Required string
Headers
Name Type Description
Idempotency-Key string Optional. Replay within 24h returns the same response.
Request body
body string
html string
type string
Enum
reply note
Example: note
to string
cc string
author_name string
author_email string
plain_text_body boolean
author_user_id integer
Response
data object

Ticket message.

id string
direction string

API creates are always `out`.

Enum
in out
type string
Enum
reply note
Example: note
body string
created_at string
author object
name string
email string
meta object
via_staff_save boolean

Examples

POST /v1/tickets/{id}/messages
curl -X POST "https://api.appficient.nl/v1/tickets/{id}/messages" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "string",
    "html": "string",
    "type": "note",
    "to": "string",
    "cc": "string",
    "author_name": "string",
    "author_email": "string",
    "plain_text_body": false,
    "author_user_id": 0
}'

Curl, Node and response are shown to the right of this endpoint.

Retrieve a ticket message

GET /v1/tickets/{id}/messages/{message_id}
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Name Type Description
id Required string
message_id Required string
Request body

None

Response
data object

Ticket message.

id string
direction string

API creates are always `out`.

Enum
in out
type string
Enum
reply note
Example: note
body string
created_at string
author object
name string
email string
meta object

Examples

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

Curl, Node and response are shown to the right of this endpoint.

List ticket channels

GET /v1/ticket-channels

Optional `active` (default `1`)

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Name Type Description
active string 1 = active (default), 0 = inactive
Request body

None

Response
data array
id string

Channel id.

name string

Channel name.

email string

Mailbox address when configured.

from_email string

From-address when configured.

from_name string

From name on outbound mail.

inbound_email string

Inbound address for forwarded mail.

forwarding_emails array

Addresses that forward into this channel.

active boolean

Whether this channel is active.

order integer

Sort order.

meta object

Examples

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

Curl, Node and response are shown to the right of this endpoint.

List ticket statuses

GET /v1/ticket-statuses

Optional `active` (default `1`)

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Name Type Description
active string 1 = active (default), 0 = inactive
Request body

None

Response
data array
id string

Status id.

name string

Status name.

active boolean

Whether this status is active.

order integer

Sort order.

meta object

Examples

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

Curl, Node and response are shown to the right of this endpoint.