Cayzu API Help Page

Authenticate

API	Description
GET api/ResetPassword?domain={domain}&email={email}	Attempts to reset a users password.
GET api/Authenticate/ResetPassword?domain={domain}&email={email}	Attempts to reset a users password.
GET api/Authenticate?domain={domain}&email={email}	Attempts to reset a users password.

Search

API	Description
GET api/search/contacts-and-tickets?q={q}	Searches all contacts and tickets based on the given query.
GET api/Search/ContactsAndTickets?q={q}	Searches all contacts and tickets based on the given query.

Brand

API	Description
GET api/brand/for_provider	Retrieves all brands for provider
GET api/brand/for_provider/by_name?name={name}	Retrieves brand with specified name
GET api/brand/for_provider/by_id?id={id}	Retrieves brand with specified id
GET api/Brand/GetBrands	Retrieves all brands for provider
GET api/Brand/GetBrandByName?name={name}	Retrieves brand with specified name
GET api/Brand/GetBrandById/{id}	Retrieves brand with specified id
GET api/Brand	Retrieves all brands for provider
GET api/Brand?name={name}	Retrieves brand with specified name
GET api/Brand/{id}	Retrieves brand with specified id

CustomForm

API	Description
GET api/custom_form/for_brand/{brandId}	Retrieves custom forms for specified brand
GET api/custom_form/by_id/{formId}	Retrieves specified custom form
GET api/CustomForm/GetCustomFormsForBrand?brandId={brandId}	Retrieves custom forms for specified brand
GET api/CustomForm/GetCustomFormById?formId={formId}	Retrieves specified custom form
GET api/CustomForm?brandId={brandId}	Retrieves custom forms for specified brand
GET api/CustomForm?formId={formId}	Retrieves specified custom form

Report

API	Description
POST api/reports/timesheet	Generates Timesheet report for agents
POST api/Report/TimesheetReport	Generates Timesheet report for agents
POST api/Report	Generates Timesheet report for agents

Quick_Response

API	Description
GET api/quick_response/{quickResponseId}/apply/{ticketId}	Applies a ticket to a quick response to replace the variables (i.e. %full_name%).
GET api/Quick_Response/Get	Retrieves the quick responses available to the logged in user.
GET api/Quick_Response/Apply?quickResponseId={quickResponseId}&ticketId={ticketId}	Applies a ticket to a quick response to replace the variables (i.e. %full_name%).
GET api/Quick_Response	Retrieves the quick responses available to the logged in user.
GET api/Quick_Response?quickResponseId={quickResponseId}&ticketId={ticketId}	Applies a ticket to a quick response to replace the variables (i.e. %full_name%).

Reply

API	Description
DELETE api/reply?id={id}&ticketId={ticketId}	Removes a reply from a support ticket.
POST api/support_ticket/{ticketId}/agent/{agentId}/reply?sendEmail={sendEmail}	Adds a reply to a specified support ticket.
POST api/support_ticket/{ticketId}/contact/{contactId}/reply?sendEmail={sendEmail}	Adds a contact reply to a specified support ticket.
GET api/support_ticket/{timestamp}/replies	Retrieves the replies to a specified support ticket.
DELETE api/support_ticket/{ticketId}/reply/{id}	Removes a reply from a support ticket.
POST api/support_ticket/{ticketId}/reply?agentId={agentId}&sendEmail={sendEmail}	Adds a reply to a specified support ticket.
POST api/support_ticket/{ticketId}/reply?contactId={contactId}&sendEmail={sendEmail}	Adds a contact reply to a specified support ticket.
DELETE api/Reply/Delete/{id}?ticketId={ticketId}	Removes a reply from a support ticket.
GET api/Reply/Get?ticketId={ticketId}	Retrieves the replies to a specified support ticket.
POST api/Reply/Post?ticketId={ticketId}&agentId={agentId}&sendEmail={sendEmail}	Adds a reply to a specified support ticket.
POST api/Reply/Post?ticketId={ticketId}&contactId={contactId}&sendEmail={sendEmail}	Adds a contact reply to a specified support ticket.
GET api/Reply/GetNewTicketReplies?timestamp={timestamp}	Retrieves the replies to a specified support ticket.
DELETE api/Reply/{id}?ticketId={ticketId}	Removes a reply from a support ticket.
GET api/Reply?ticketId={ticketId}	Retrieves the replies to a specified support ticket.
POST api/Reply?ticketId={ticketId}&agentId={agentId}&sendEmail={sendEmail}	Adds a reply to a specified support ticket.
POST api/Reply?ticketId={ticketId}&contactId={contactId}&sendEmail={sendEmail}	Adds a contact reply to a specified support ticket.
GET api/Reply?timestamp={timestamp}	Retrieves the replies to a specified support ticket.

Support_Ticket

API	Description
GET api/support_ticket/{ticketId}	Retrieves the support ticket with the specified Id.
GET api/support_ticket/by_subid/{subId}	Retrieves the support ticket with the specified SubId.
GET api/support_ticket/my_unresolved	Retrieves all of the unresolved tickets assigned to the logged in user.
GET api/support_ticket/my_unresolved?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of the unresolved tickets assigned to the logged in user.
GET api/support_ticket/my_unresolved/{pageNumber}/{pageSize}	Retrieves all of the unresolved tickets assigned to the logged in user.
GET api/support_ticket/resolved_by_all/{pageNumber}/{pageSize}/{daysFromNow}	Returns resolved tickets for period of days. Limit 500 per page.
GET api/support_ticket/resolved_by_all/with_custom_fields/{pageNumber}/{pageSize}/{daysFromNow}	Returns resolved tickets and custom fields for period of days
GET api/support_ticket/my_unsolved_in_my_group/{pageNumber}/{pageSize}	Retrieves all unsolved tickets assigned to the logged in user by pages, filtered by current member group
GET api/support_ticket/other_unresolved	Retrieves all of the unresolved tickets that are not assigned to the logged in user.
GET api/support_ticket/other_unresolved?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of the unresolved tickets that are not assigned to the logged in user.
GET api/support_ticket/other_unresolved/{pageNumber}/{pageSize}	Retrieves all of the unresolved tickets that are not assigned to the logged in user.
GET api/support_ticket/advanced_stats	Retrieves support ticket count stats in advanced mode.
GET api/support_ticket/unassigned/{pageNumber}/{pageSize}	Retrieves all unassigned support tickets by pages.
GET api/support_ticket/overdue/{pageNumber}/{pageSize}	Retrieves all overdue support tickets by pages.
GET api/support_ticket/unresolved_with_custom_fields	Retrieves all unassigned support tickets with custom fields.
GET api/support_ticket/company_tickets_with_custom_fields?id={id}	Retrieves company tickets with custom fields.
GET api/support_ticket/company_tickets_with_custom_fields_by_page/{id}/{pageNumber}/{pageSize}	Retrieves company tickets with custom fields by pages.
GET api/support_ticket/unresolved/{pageNumber}/{pageSize}?useGroupFilter={useGroupFilter}	Retrieves all unresolved support tickets by pages.
GET api/support_ticket/unresolved_in_my_groups/{pageNumber}/{pageSize}?useGroupFilter={useGroupFilter}	Retrieves all unresolved support tickets by pages, filtered by current member group
GET api/support_ticket/team_unsolved_tickets/{pageNumber}/{pageSize}	Retrieves all unsolved support tickets by team.
GET api/Support_Ticket/GetTicketById?ticketId={ticketId}	Retrieves the support ticket with the specified Id.
GET api/Support_Ticket/GetBySubId?subId={subId}	Retrieves the support ticket with the specified SubId.
GET api/Support_Ticket/MyUnresolved	Retrieves all of the unresolved tickets assigned to the logged in user.
GET api/Support_Ticket/MyUnresolved?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of the unresolved tickets assigned to the logged in user.
GET api/Support_Ticket/MyUnsolved?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all unsolved tickets assigned to the logged in user by pages.
GET api/Support_Ticket/ResolvedByAll?pageNumber={pageNumber}&pageSize={pageSize}&daysFromNow={daysFromNow}	Returns resolved tickets for period of days. Limit 500 per page.
GET api/Support_Ticket/ResolvedByAllWithCustomFields?pageNumber={pageNumber}&pageSize={pageSize}&daysFromNow={daysFromNow}	Returns resolved tickets and custom fields for period of days
GET api/Support_Ticket/MyUnsolvedInMyGroup?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all unsolved tickets assigned to the logged in user by pages, filtered by current member group
GET api/Support_Ticket/UnresolvedByOther	Retrieves all of the unresolved tickets that are not assigned to the logged in user.
GET api/Support_Ticket/UnresolvedByOther?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of the unresolved tickets that are not assigned to the logged in user.
POST api/Support_Ticket/Post?email_customer={email_customer}&disableNotification={disableNotification}	Creates a new support ticket.
POST api/Support_Ticket/Post/{id}	Updates an existing support ticket.
GET api/Support_Ticket/AdvancedStats	Retrieves support ticket count stats in advanced mode.
GET api/Support_Ticket/Overdue?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all overdue support tickets by pages.
GET api/Support_Ticket/UnassignedWithCustomFields	Retrieves all unassigned support tickets with custom fields.
GET api/Support_Ticket/CompanyTicketsWithCustomFields/{id}	Retrieves company tickets with custom fields.
GET api/Support_Ticket/CompanyTicketsWithCustomFieldsPageble/{id}?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves company tickets with custom fields by pages.
GET api/Support_Ticket/UnresolvedInMyGroups?pageNumber={pageNumber}&pageSize={pageSize}&useGroupFilter={useGroupFilter}	Retrieves all unresolved support tickets by pages, filtered by current member group
GET api/Support_Ticket/TeamUnsolved?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all unsolved support tickets by team.
DELETE api/Support_Ticket/DeleteTicket?subId={subId}	Removes a ticket from the system.
GET api/Support_Ticket?ticketId={ticketId}	Retrieves the support ticket with the specified Id.
GET api/Support_Ticket?subId={subId}	Retrieves the support ticket with the specified SubId.
POST api/Support_Ticket?email_customer={email_customer}&disableNotification={disableNotification}	Creates a new support ticket.
POST api/Support_Ticket/{id}	Updates an existing support ticket.
GET api/Support_Ticket/{id}	Retrieves company tickets with custom fields.
GET api/Support_Ticket/{id}?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves company tickets with custom fields by pages.
DELETE api/Support_Ticket?subId={subId}	Removes a ticket from the system.

Alternate_Domain

API	Description
DELETE api/alternate_domain?id={id}	Removes an alternate domain from a customer.
GET api/customer/{customerId}/alternate_domain	Retrieves the alternate domains associated with a customer.
DELETE api/Alternate_Domain/Delete/{id}	Removes an alternate domain from a customer.
GET api/Alternate_Domain/Get?customerId={customerId}	Retrieves the alternate domains associated with a customer.
POST api/Alternate_Domain/Post	Adds a new alternate domain to an existing customer.
DELETE api/Alternate_Domain/{id}	Removes an alternate domain from a customer.
GET api/Alternate_Domain?customerId={customerId}	Retrieves the alternate domains associated with a customer.

Product

API	Description
GET api/product/for_brand/{brandId}	Retrieves the products available in the system.
GET api/Product/GetProductsForBrand?brandId={brandId}	Retrieves the products available in the system.
GET api/Product?brandId={brandId}	Retrieves the products available in the system.

Faq_Item

API	Description
GET api/faq_items_list	Retrieves the FAQ items list for current provider
GET api/faq_items_list?offset={offset}&page_size={page_size}	Retrieves the FAQ items list for current provider by pages
GET api/Faq_Item/Get/{id}	Retrieves a FAQ item with the given Id.
GET api/Faq_Item/GetAvailableFaqItems	Retrieves the FAQ items list for current provider
GET api/Faq_Item/GetAvailableFaqItemsPageble?offset={offset}&page_size={page_size}	Retrieves the FAQ items list for current provider by pages
GET api/Faq_Item	Retrieves the FAQ items list for current provider
GET api/Faq_Item?offset={offset}&page_size={page_size}	Retrieves the FAQ items list for current provider by pages

Kb_Item

API	Description
PUT api/kb_item/{kbItemId}/tag/{tagId}	Associates a tag to a knowledge base item.
GET api/kb_item?id={id}	Retrieves a knowledge base item with the given Id.
GET api/kb_items_list	Retrieves the knowledge base items list for current provider
POST api/kb_item?id={id}	Updates an existing knowledge base item.
PUT api/Kb_Item/AssociateTag?kbItemId={kbItemId}&tagId={tagId}	Associates a tag to a knowledge base item.
GET api/Kb_Item/Get?offset={offset}&page_size={page_size}	Retrieves the knowledge base items by pages
GET api/Kb_Item/Get/{id}	Retrieves a knowledge base item with the given Id.
GET api/Kb_Item/GetAvailableKbItems	Retrieves the knowledge base items list for current provider
GET api/Kb_Item/ListForTags?offset={offset}&page_size={page_size}	Retrieves the knowledge base items associated with all of the specified tags.
POST api/Kb_Item/Post	Creates a new knowledge base item.
POST api/Kb_Item/Post/{id}	Updates an existing knowledge base item.
PUT api/Kb_Item?kbItemId={kbItemId}&tagId={tagId}	Associates a tag to a knowledge base item.
GET api/Kb_Item	Retrieves the knowledge base items list for current provider

News_Item

API	Description
GET api/news_items_list	Retrieves the NEWS items list for current provider
GET api/news_items_list?offset={offset}&page_size={page_size}	Retrieves the NEWS items list for current provider by pages
GET api/News_Item/Get/{id}	Retrieves a NEWS item with the given Id.
GET api/News_Item/GetAvailableNewsItems	Retrieves the NEWS items list for current provider
GET api/News_Item/GetAvailableNewsItemsPagable?offset={offset}&page_size={page_size}	Retrieves the NEWS items list for current provider by pages
GET api/News_Item	Retrieves the NEWS items list for current provider
GET api/News_Item?offset={offset}&page_size={page_size}	Retrieves the NEWS items list for current provider by pages

AssetCategory

API	Description
GET api/asset/category/get_by_id/{id}	Retrieves specified asset category
GET api/asset/category/get_by_id?id={id}	Retrieves specified asset category
GET api/asset/category/get_by_name/{name}	Retrieves specified asset category
GET api/asset/category/get_by_name?name={name}	Retrieves specified asset category
POST api/asset/category/create	Create assets category
GET api/asset/category/get_by_brandId/{brandId}?offset={offset}&page_size={page_size}	Retrieves asset categories by brandId
GET api/AssetCategory/GetAssetCategoryById/{id}	Retrieves specified asset category
GET api/AssetCategory/GetAssetCategoryById1/{id}	Retrieves specified asset category
GET api/AssetCategory/GetAssetCategoryByName?name={name}	Retrieves specified asset category
GET api/AssetCategory/GetAssetCategoryByName1?name={name}	Retrieves specified asset category
POST api/AssetCategory/CreateAssetCategory	Create assets category
GET api/AssetCategory/GetAssetCategoriesById?brandId={brandId}&offset={offset}&page_size={page_size}	Retrieves asset categories by brandId
POST api/AssetCategory	Create assets category
GET api/AssetCategory?brandId={brandId}&offset={offset}&page_size={page_size}	Retrieves asset categories by brandId

Asset

API	Description
GET api/asset/get_by_id/{id}	Retrieves specified asset
POST api/asset/create	Create asset
GET api/asset/get_by_assetCategoryId/{assetCategoryId}?offset={offset}&page_size={page_size}	Retrieves assets by Asset Category Id
GET api/asset/get_by_customerId/{customerId}?offset={offset}&page_size={page_size}	Retrieves assets by Customer Id
GET api/Asset/GetAssetById/{id}	Retrieves specified asset
POST api/Asset/CreateAsset	Create asset
GET api/Asset/GetAssetsByAssetCategoryId?assetCategoryId={assetCategoryId}&offset={offset}&page_size={page_size}	Retrieves assets by Asset Category Id
GET api/Asset/GetAssetsByCustomerId?customerId={customerId}&offset={offset}&page_size={page_size}	Retrieves assets by Customer Id
GET api/Asset/{id}	Retrieves specified asset
POST api/Asset	Create asset
GET api/Asset?assetCategoryId={assetCategoryId}&offset={offset}&page_size={page_size}	Retrieves assets by Asset Category Id
GET api/Asset?customerId={customerId}&offset={offset}&page_size={page_size}	Retrieves assets by Customer Id

Customer

API	Description
GET api/Customer/domain?domain={domain}	Retrieves the customer with the specified Domain and Name.
GET api/Customer/Get?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the customers associated with your provider account.
GET api/Customer/Get/{id}	Retrieves the customer with the specified Id.
GET api/Customer/GetByDomain?domain={domain}	Retrieves the customer with the specified Domain and Name.
POST api/Customer/RemoveCustomer/{id}	Deletes the company
POST api/Customer/CreateCustomer	Creates a new customer.
POST api/Customer/UpdateCustomer/{id}	Updates an existing customer.
GET api/Customer?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the customers associated with your provider account.
GET api/Customer/{id}	Retrieves the customer with the specified Id.
GET api/Customer?domain={domain}	Retrieves the customer with the specified Domain and Name.
POST api/Customer	Creates a new customer.

Date_Format

API	Description
GET api/Date_Format/Get	Retrieves the date formats available in the system.
GET api/Date_Format/Get/{id}	Retrieves the date format with the specified Id.
GET api/Date_Format	Retrieves the date formats available in the system.
GET api/Date_Format/{id}	Retrieves the date format with the specified Id.

Ticket_Type

API	Description
GET api/Ticket_Type/Get	Retrieves all of the ticket types in the system.
GET api/Ticket_Type	Retrieves all of the ticket types in the system.

Individual

API	Description
GET api/Individual/Get?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of your contacts with pagination.
GET api/Individual/Get?customerId={customerId}	Retrieves the contacts of a customer.
GET api/Individual/Get?email={email}	Retrieves the individual by email.
POST api/Individual/RemoveContact?contactid={contactid}	Deletes the contact
GET api/Individual/GetById/{id}	Retrieves the individual with the specified Id.
POST api/Individual/CreateContactForCustomer?customerId={customerId}	Creates a new contact under and existing customer
POST api/Individual/CreateContact	Creates a new contact as individual
POST api/Individual/UpdateContact?customerId={customerId}&contactId={contactId}	Update a existed contact
GET api/Individual?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all of your contacts with pagination.
GET api/Individual?customerId={customerId}	Retrieves the contacts of a customer.
GET api/Individual?email={email}	Retrieves the individual by email.
POST api/Individual?contactid={contactid}	Deletes the contact
GET api/Individual/{id}	Retrieves the individual with the specified Id.
POST api/Individual?customerId={customerId}	Creates a new contact under and existing customer
POST api/Individual	Creates a new contact as individual
POST api/Individual?customerId={customerId}&contactId={contactId}	Update a existed contact

Asset_Custom_Field

API	Description
GET api/Asset_Custom_Field/GetByAssetCategoryId?assetCategoryId={assetCategoryId}	Retrieves the Asset Category fields.
GET api/Asset_Custom_Field?assetCategoryId={assetCategoryId}	Retrieves the Asset Category fields.

Group

API	Description
GET api/Group/Get?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the groups associated with your provider account.
GET api/Group?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the groups associated with your provider account.

Customer_Custom_Field

API	Description
GET api/Customer_Custom_Field/Get/{id}	Retrieves the specified customers custom fields.
GET api/Customer_Custom_Field/{id}	Retrieves the specified customers custom fields.

Provider

API	Description
POST api/Provider/DirectCreate	Registers a new provider account.

Priority

API	Description
GET api/Priority/Get	Retrieves all of the priorities available in the system.
GET api/Priority	Retrieves all of the priorities available in the system.

System_Status_Notifications

API	Description
GET api/System_Status_Notifications/Get?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all the individual subscribed to notifications in your provider account.
POST api/System_Status_Notifications/Post	Subscribes a new individual to your notifications
GET api/System_Status_Notifications?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves all the individual subscribed to notifications in your provider account.
POST api/System_Status_Notifications	Subscribes a new individual to your notifications

System_Status

API	Description
GET api/System_Status/Get?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the system status associated with your provider account.
POST api/System_Status/Post	Creates a new system status.
GET api/System_Status?pageNumber={pageNumber}&pageSize={pageSize}	Retrieves the system status associated with your provider account.
POST api/System_Status	Creates a new system status.

AgentSearch

API	Description
GET api/AgentSearch/Get?email={email}	Retrieves the contacts by email.
GET api/AgentSearch?email={email}	Retrieves the contacts by email.

Source

API	Description
GET api/Source/Get	Retrieves all of the sources in the system.
GET api/Source	Retrieves all of the sources in the system.

Time_Format

API	Description
GET api/Time_Format/Get	Retrieves the time formats available in the system.
GET api/Time_Format	Retrieves the time formats available in the system.

Support_Ticket_Custom_Field

API	Description
GET api/Support_Ticket_Custom_Field/Get/{id}	Retrieves the specified tickets custom fields.
GET api/Support_Ticket_Custom_Field/{id}	Retrieves the specified tickets custom fields.

Forms_Custom_Field

API	Description
GET api/Forms_Custom_Field/Get	Retrieves the forms custom fields.
GET api/Forms_Custom_Field	Retrieves the forms custom fields.

Agent

API	Description
GET api/Agent/Get	Retrieves the agents associated with your account.
GET api/Agent/Get?email={email}	Retrieves the agents associated with your account.
GET api/Agent/Get/{id}	Retrieves the agent with the specified Id.
POST api/Agent/Post	Creates a new agent.
POST api/Agent/Post/{id}	Updates an existing agent.
GET api/Agent	Retrieves the agents associated with your account.
GET api/Agent?email={email}	Retrieves the agents associated with your account.
GET api/Agent/{id}	Retrieves the agent with the specified Id.
POST api/Agent	Creates a new agent.
POST api/Agent/{id}	Updates an existing agent.

Support_Ticket_Zapier

API	Description
POST api/Support_Ticket_Zapier/Post?email_customer={email_customer}&disableNotification={disableNotification}	Create ticket from zapier
POST api/Support_Ticket_Zapier?email_customer={email_customer}&disableNotification={disableNotification}	Create ticket from zapier

Status

API	Description
GET api/Status/Get	Retrieves all of the statuses in the system.
GET api/Status	Retrieves all of the statuses in the system.

Tag

API	Description
DELETE api/Tag/Delete/{id}	Removes a tag from the system.
GET api/Tag/Get	Retrieves all of the tags in the system.
GET api/Tag/Get/{id}	Retrieves the tag with the given Id.
POST api/Tag/Post	Creates a new tag.
POST api/Tag/Post/{id}	Updates an existing tag.
DELETE api/Tag/{id}	Removes a tag from the system.
GET api/Tag	Retrieves all of the tags in the system.
GET api/Tag/{id}	Retrieves the tag with the given Id.
POST api/Tag	Creates a new tag.
POST api/Tag/{id}	Updates an existing tag.

Attachment

API	Description
POST api/Attachment/Upload?ticketId={ticketId}&replyId={replyId}	Uploads an attachment for ticket or reply
GET api/Attachment/GetTicketAttachments?ticketId={ticketId}	Retrieves the list of attachments (for ticket body or reply)
POST api/Attachment?ticketId={ticketId}&replyId={replyId}	Uploads an attachment for ticket or reply
GET api/Attachment?ticketId={ticketId}	Retrieves the list of attachments (for ticket body or reply)

Echo

API	Description
GET api/Echo	Echo action for the testing API work

Want more information on Cayzu Helpdesk, visit: www.cayzu.com