Actions (68)
Tickets · 28
- Add ticket accessPOST /api/v2/tickets/{id}/accesses
Provide access to users for a ticket.
documented - Add watcher to multiple ticketsPUT /api/v2/tickets/bulk_watch
Add a watcher to multiple tickets in bulk.
documented - Add watcher to ticketPOST /api/v2/tickets/[id]/watch
Add a watcher to a ticket.
documented - Bulk delete ticketsPOST /api/v2/tickets/bulk_delete
Bulk delete tickets in the background.
documented - Create outbound emailPOST /api/v2/tickets/outbound_email
Send an outbound email related to a ticket.
documented - Create ticketPOST /api/v2/tickets
Create a new ticket.
documented - Delete attachmentDELETE /api/v2/attachments/{id}
Delete an attachment from a ticket.
documented - Delete ticketDELETE /api/v2/tickets/{id}
Delete a ticket.
documented - Filter ticketsGET /api/v2/search/tickets?query={query}
Search tickets using a query.
documented - Forward ticketPOST /api/v2/tickets/{id}/forward
Forward a ticket to another recipient.
documented - Get ticket access listGET /api/v2/tickets/{id}/accesses
Get users with access to a ticket.
documented - Get ticket summaryGET /api/v2/tickets/{id}/summary
Get the current summary for a ticket.
documented - List all conversations of a ticketGET /api/v2/tickets/{id}/conversations
List all conversations (replies/notes) for a ticket.
documented - List all ticket fieldsGET /api/v2/ticket_fields
List all ticket fields.
documented - List all time entries of a ticketGET /api/v2/tickets/{id}/time_entries
List time entries associated with a ticket.
documented - List conversations of archived ticketGET /api/v2/tickets/archived/{id}/conversations
List conversations for an archived ticket.
documented - List satisfaction ratingsGET /api/v2/tickets/{ticket_id}/satisfaction_ratings
List satisfaction ratings for a ticket.
documented - List ticketsGET /api/v2/tickets
List all tickets with optional filtering.
documented - Merge ticketsPOST /api/v2/tickets/merge
Merge tickets into a single ticket.
documented - Remove ticket accessDELETE /api/v2/tickets/{id}/accesses
Remove access to a ticket for users.
documented - Remove watcher from ticketPUT /api/v2/tickets/[id]/unwatch
Remove a watcher from a ticket.
documented - Remove watchers from multiple ticketsPUT /api/v2/tickets/bulk_unwatch
Remove watchers from multiple tickets in bulk.
documented - Restore ticketPUT /api/v2/tickets/{id}/restore
Restore a previously deleted ticket.
documented - Update multiple ticketsPUT /api/v2/tickets/bulk_update
Bulk update multiple tickets in a single call.
documented - Update ticketPUT /api/v2/tickets/{id}
Update a ticket.
documented - Update ticket accessPATCH /api/v2/tickets/{id}/accesses
Update ticket access for users.
documented - View archived ticketGET /api/v2/tickets/archived/{id}
View details of an archived (auto-archived) ticket.
documented - View ticketGET /api/v2/tickets/{id}
Retrieve details of a single ticket.
documented
Contacts · 17
- Create contactPOST /api/v2/contacts
Create a new contact.
documented - Export contactsPOST /api/v2/contacts/export
Initiate a contact export.
documented - Get exported contacts URLGET /api/v2/contacts/export/{id}
Fetch export URL for a completed contact export.
documented - Hard delete contactDELETE /api/v2/contacts/{id}/hard_delete
Permanently delete a contact.
documented - List contact importsGET /api/v2/contacts/imports
List recent contact imports.
documented - List contactsGET /api/v2/contacts
List all contacts.
documented - Make agent from contactPOST /api/v2/contacts/{id}/make_agent
Convert a contact to an agent.
documented - Merge contactsPOST /api/v2/contacts/merge
Merge contacts (duplicate resolution).
documented - Merge contactsPOST /api/v2/contacts/merge
Merge two or more contacts.
documented - Restore contactGET /api/v2/contacts/{id}/restore
Restore a previously deleted contact.
documented - Search contacts autocompleteGET /api/v2/contacts/autocomplete?term={keyword}
Autocomplete search for contacts by keyword.
documented - Send invite to contactPOST /api/v2/contacts/{id}/send_invite
Invite a contact to join the portal.
documented - Soft delete contactDELETE /api/v2/contacts/{id}
Soft delete a contact.
documented - Start contact importPOST /api/v2/contacts/imports
Start a contact import job.
documented - Update contactPUT /api/v2/contacts/{id}
Update a contact.
documented - View contactGET /api/v2/contacts/{id}
View a single contact.
documented - View contact importGET /api/v2/contacts/imports/{id}
View a contact import status/details.
documented
Companies · 12
- Create companyPOST /api/v2/companies
Create a new company.
documented - Delete companyDELETE /api/v2/companies/{id}
Delete a company.
documented - Export companiesPOST /api/v2/companies/export
Export a list of companies.
documented - Filter companiesGET /api/v2/search/companies?query={query}
Search companies with a query.
documented - Get exported companies URLGET /api/v2/companies/export/{id}
Retrieve URL for completed company export.
documented - List companiesGET /api/v2/companies
List all companies.
documented - List company importsGET /api/v2/companies/imports
List recent company imports.
documented - Search companies autocompleteGET /api/v2/companies/autocomplete?name={keyword}
Autocomplete search for companies by name.
documented - Start company importPOST /api/v2/companies/imports
Start a company import job.
documented - Update companyPUT /api/v2/companies/{id}
Update a company.
documented - View companyGET /api/v2/companies/{id}
View a company.
documented - View company importGET /api/v2/companies/imports/{id}
View a company import status/details.
documented
Custom Objects · 9
- Count custom object recordsGET /api/v2/custom_objects/schemas/schema_id/records/count
Get count of records for a custom object schema.
documented - Create custom object recordPOST /api/v2/custom_objects/schemas/{schema-id}/records
Create a new record in a custom object schema.
documented - Delete custom object recordDELETE /api/v2/custom_objects/schemas/{schema-id}/records/{record-id}
Delete a custom object record.
documented - Filter custom object recordsGET /api/v2/custom_objects/schemas/schema-id/records?{field-name}{operator}{value}
Filter records in a custom object.
documented - List custom object recordsGET /api/v2/custom_objects/schemas/{schema-id}/records
List records for a custom object schema.
documented - List custom object schemasGET /api/v2/custom_objects/schemas
List all custom object schemas.
documented - Update custom object recordPUT /api/v2/custom_objects/schemas/{schema-id}/records/{record-id}
Update a custom object record.
documented - View custom object recordGET /api/v2/custom_objects/schemas/{schema-id}/records/{record-id}
Get a specific custom object record.
documented - View custom object schemaGET /api/v2/custom_objects/schemas/{schema-id}
View a specific custom object schema.
documented