Open HelpDesk API
integer · min: 1 · max: 100stringstring · emailstring · required
string · uuid · requiredboolean
string · uuid · requiredstring · emailstringstringstringbooleanstring · uuidstring · emailstringstringstringbooleanstring · date-time
Contacts
The people who write in.
List contacts
GET
https://{workspace}.open-helpdesk.com/api/v1
/contacts
query Parameters
limitRows per page.
Default: 25
cursorThe next_cursor of the previous page.
emailExact address.
List contacts › Responses
List contacts
Contact[] · required
next_cursorPass back as cursor for the next page. Null on the last page.
Create a contact
POST
https://{workspace}.open-helpdesk.com/api/v1
/contacts
Read a contact
GET
https://{workspace}.open-helpdesk.com/api/v1
/contacts/{id}
Delete a contact (GDPR erasure)
DELETE
https://{workspace}.open-helpdesk.com/api/v1
/contacts/{id}
Refused with 409 while the person still has tickets, unless delete_tickets=true is passed — erasing a support history should be asked for, not inferred. To merely stop someone writing in, set blocked instead.
path Parameters
idThe contact id.
Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83
query Parameters
delete_ticketsAlso erase their tickets.
Delete a contact (GDPR erasure) › Responses
Deleted.
No data returned
Update a contact
PATCH
https://{workspace}.open-helpdesk.com/api/v1
/contacts/{id}
path Parameters
idThe contact id.
Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83
Update a contact › Request Body
emailnamephonelocaleblockedobject
Update a contact › Responses
Success.
idemailnamephonelocaleblockedobject
created_at