| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.cayzu.com/ | link | — | — | — |
Actions (194)
Support_Ticket · 31
- Create ticketPOST api/Support_Ticket/Post?email_customer={email_customer}&disableNotification={disableNotification}
Creates a new support ticket.
documented - Delete ticket (alternate)DELETE api/Support_Ticket?subId={subId}
Removes a ticket from the system.
documented - Delete ticket by SubIdDELETE api/Support_Ticket/DeleteTicket?subId={subId}
Removes a ticket by subId.
documented - Get advanced ticket statsGET api/Support_Ticket/AdvancedStats
Retrieves advanced ticket count stats.
documented - Get company tickets with custom fieldsGET api/Support_Ticket/CompanyTicketsWithCustomFields/{id}?includeDescription={includeDescription}
Retrieves company tickets with custom fields.
documented - Get ticket by IDGET api/Support_Ticket/GetTicketById?ticketId={ticketId}
Retrieves the ticket by ID.
documented - Get ticket by ID (alternate 2)GET api/Support_Ticket?ticketId={ticketId}
Retrieves the ticket by ID.
documented - Get ticket by ID (paged)GET api/Support_Ticket/{id}?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves a ticket with fields and paging.
documented - Get ticket by SubIdGET api/Support_Ticket/GetBySubId?subId={subId}
Retrieves the ticket by SubId.
documented - Get ticket by SubId (alternate)GET api/Support_Ticket?subId={subId}
Retrieves a ticket by SubId.
documented - Get ticket with fieldsGET api/Support_Ticket/{id}?includeDescription={includeDescription}
Retrieves a ticket with its custom fields.
documented - List all ticketsGET api/Support_Ticket/ListAll?viewId={viewId}&pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
No documentation available.
documented - List all tickets (alternate)GET api/Support_Ticket?viewId={viewId}&pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
No documentation available.
documented - List company tickets with custom fields (paged)GET api/Support_Ticket/CompanyTicketsWithCustomFieldsPageble/{id}?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves company tickets with custom fields by page.
documented - List overdue ticketsGET api/Support_Ticket/Overdue?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves overdue tickets.
documented - List resolved tickets for all usersGET api/Support_Ticket/ResolvedByAll?pageNumber={pageNumber}&pageSize={pageSize}&daysFromNow={daysFromNow}&includeDescription={includeDescription}
Returns resolved tickets over a period.
documented - List resolved tickets with custom fieldsGET api/Support_Ticket/ResolvedByAllWithCustomFields?pageNumber={pageNumber}&pageSize={pageSize}&daysFromNow={daysFromNow}&includeDescription={includeDescription}
Returns resolved tickets with custom fields for a period.
documented - List team unsolved ticketsGET api/Support_Ticket/TeamUnsolved?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves unsolved tickets for the team.
documented - List tickets by parametersGET api/Support_Ticket/OtherTickets?pageNumber={pageNumber}&pageSize={pageSize}&statusId={statusId}&brandId={brandId}&priorityId={priorityId}&ticketTypeId={ticketTypeId}&createStartDateTimeUtc={createStartDateTimeUtc}&createEndDateTimeUtc={createEndDateTimeUtc}&includeDescription={includeDescription}
Retrieves tickets by the given filter parameters.
documented - List tickets by parameters (alternate)GET api/Support_Ticket?pageNumber={pageNumber}&pageSize={pageSize}&statusId={statusId}&brandId={brandId}&priorityId={priorityId}&ticketTypeId={ticketTypeId}&createStartDateTimeUtc={createStartDateTimeUtc}&createEndDateTimeUtc={createEndDateTimeUtc}&includeDescription={includeDescription}
Retrieves tickets by the specified parameters.
documented - List unassigned tickets with custom fieldsGET api/Support_Ticket/UnassignedWithCustomFields?includeDescription={includeDescription}
Retrieves unassigned tickets with custom fields.
documented - List unresolved tickets by otherGET api/Support_Ticket/UnresolvedByOther?includeDescription={includeDescription}
Retrieves unresolved tickets not assigned to the user.
documented - List unresolved tickets by other (paged)GET api/Support_Ticket/UnresolvedByOther?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves unresolved tickets not assigned to the user, paged.
documented - List unresolved tickets for userGET api/Support_Ticket/MyUnresolved?includeDescription={includeDescription}
Retrieves all unresolved tickets assigned to the logged in user.
documented - List unresolved tickets for user (paged)GET api/Support_Ticket/MyUnresolved?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves unresolved tickets for the user with paging.
documented - List unresolved tickets in my groupGET api/Support_Ticket/MyUnsolvedInMyGroup?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves unresolved tickets assigned to your group.
documented - List unresolved tickets in my groupsGET api/Support_Ticket/UnresolvedInMyGroups?pageNumber={pageNumber}&pageSize={pageSize}&useGroupFilter={useGroupFilter}&includeDescription={includeDescription}
Retrieves unresolved tickets by group filter.
documented - List unsolved tickets for user (paged)GET api/Support_Ticket/MyUnsolved?pageNumber={pageNumber}&pageSize={pageSize}&includeDescription={includeDescription}
Retrieves unsolved tickets for the user with paging.
documented - Update ticketPOST api/Support_Ticket/Post/{id}
Updates an existing support ticket.
documented - Update ticket (alternate)POST api/Support_Ticket/{id}
Updates an existing ticket.
documented - Update ticket (legacy)POST api/support_ticket?id={id}
Updates an existing support ticket.
documented
Individual · 16
- Create contactPOST api/Individual/CreateContact
Creates a new contact as an individual.
documented - Create contact for customerPOST api/Individual/CreateContactForCustomer?customerId={customerId}
Creates a new contact under an existing customer.
documented - Create contact for customer (alternate)POST api/Individual?customerId={customerId}
Creates a new contact under an existing customer.
documented - Create individual contactPOST api/Individual
Creates a new contact as an individual.
documented - Delete contactPOST api/Individual/RemoveContact?contactid={contactid}
Deletes a contact.
documented - Delete contact (alternate)POST api/Individual?contactid={contactid}
Deletes the contact.
documented - Get contact by IDGET api/Individual/GetById/{id}
Retrieves the individual by Id.
documented - Get contacts by customerGET api/Individual/Get?customerId={customerId}
Retrieves the contacts of a customer.
documented - Get contacts by customer (alternate)GET api/Individual?customerId={customerId}
Retrieves the contacts of a customer.
documented - Get individual by IDGET api/Individual/{id}
Retrieves the individual by Id.
documented - Get individual by emailGET api/Individual/Get?email={email}
Retrieves the individual by email.
documented - Get individual by email (alternate)GET api/Individual?email={email}
Retrieves the individual by email.
documented - List contactsGET api/Individual/Get?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves all of your contacts with pagination.
documented - List contacts (paged)GET api/Individual?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves all of your contacts with pagination.
documented - Update contactPOST api/Individual/UpdateContact?customerId={customerId}&contactId={contactId}
Update an existing contact.
documented - Update contact (alternate)POST api/Individual?customerId={customerId}&contactId={contactId}
Updates an existing contact.
documented
Customer · 11
- Create customerPOST api/Customer/CreateCustomer
Creates a new customer.
documented - Create customer (or upsert)POST api/Customer
Creates a new customer (or upserts depending on implementation).
documented - Delete customerPOST api/Customer/RemoveCustomer/{id}
Deletes the customer.
documented - Get customer by IDGET api/Customer/Get/{id}
Retrieves the customer with the specified Id.
documented - Get customer by ID (alternate path)GET api/Customer/{id}
Retrieves the customer with the specified Id.
documented - Get customer by domainGET api/Customer/domain?domain={domain}
Retrieves the customer with the specified domain.
documented - Get customer by domain (alternative)GET api/Customer/GetByDomain?domain={domain}
Retrieves the customer with the specified Domain and Name.
documented - Get customer by domain (query)GET api/Customer?domain={domain}
Retrieves the customer for the specified domain.
documented - List customersGET api/Customer/Get?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves the customers associated with your provider account.
documented - List customers (paged)GET api/Customer?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves customers with paging parameters.
documented - Update customerPOST api/Customer/UpdateCustomer/{id}
Updates an existing customer.
documented
Reply · 11
- Add reply by agentPOST api/support_ticket/{ticketId}/reply?agentId={agentId}&sendEmail={sendEmail}
Adds a reply to a ticket by agent and optionally emails the user.
documented - Add reply by contactPOST api/support_ticket/{ticketId}/reply?contactId={contactId}&sendEmail={sendEmail}
Adds a reply to a ticket by contact and optionally emails the user.
documented - Create reply (agent)POST api/Reply/Post?ticketId={ticketId}&agentId={agentId}&sendEmail={sendEmail}
Adds a reply to a ticket by an agent.
documented - Create reply (contact)POST api/Reply/Post?ticketId={ticketId}&contactId={contactId}&sendEmail={sendEmail}
Adds a reply to a ticket by a contact.
documented - Delete reply (by internal id)DELETE api/Reply/Delete/{id}?ticketId={ticketId}
Removes a reply by its internal id for a given ticket.
documented - Delete reply by IDDELETE api/support_ticket/{ticketId}/reply/{id}
Removes a reply from a specific ticket.
documented - Get default replyGET api/Reply/GetDefaultReply?memberId={memberId}
Retrieves the default reply for a member.
documented - Get new ticket repliesGET api/Reply/GetNewTicketReplies?timestamp={timestamp}
Fetches new replies since a timestamp.
documented - Get replies by ticketGET api/Reply?ticketId={ticketId}
Retrieves replies associated with a ticket.
documented - Get replies by timestampGET api/Reply?timestamp={timestamp}
Retrieves replies since a timestamp (alternative view).
documented - List replies for ticketGET api/Reply/Get?ticketId={ticketId}
Retrieves replies for a specific ticket.
documented
Tag · 10
- Create tagPOST api/Tag/Post
Creates a new tag.
documented - Create tag (alternate)POST api/Tag
Creates a new tag.
documented - Delete tagDELETE api/Tag/Delete/{id}
Removes a tag from the system.
documented - Delete tag (alternate)DELETE api/Tag/{id}
Removes a tag by ID.
documented - Get tag by IDGET api/Tag/Get/{id}
Retrieves the tag with the given Id.
documented - Get tag by ID (alternate)GET api/Tag/{id}
Retrieves the tag with the given Id.
documented - List tagsGET api/Tag/Get
Retrieves all of the tags in the system.
documented - List tags (alternate)GET api/Tag
Retrieves all of the tags in the system.
documented - Update tagPOST api/Tag/Post/{id}
Updates an existing tag.
documented - Update tag (alternate)POST api/Tag/{id}
Updates an existing tag.
documented
Agent · 9
- Create agentPOST api/Agent/Post
Creates a new agent.
documented - Create agent (alternate)POST api/Agent
Creates a new agent.
documented - Get agent by IDGET api/Agent/Get/{id}
Retrieves the agent with the specified Id.
documented - Get agent by ID (alternate)GET api/Agent/{id}
Retrieves the agent with the specified Id.
documented - Get agents by emailGET api/Agent/Get?email={email}
Retrieves the agents associated with your account by email.
documented - Get agents by email (alternate)GET api/Agent?email={email}
Retrieves the agents associated with your account by email.
documented - List agentsGET api/Agent/Get
Retrieves the agents associated with your account.
documented - List agents (alternate)GET api/Agent
Retrieves the agents associated with your account.
documented - Update agentPUT api/Agent/Put/{id}
Updates an existing agent.
documented
Contract · 9
- Create contractPOST api/Contract/Post?customerId={customerId}
Creates a new contract for a customer.
documented - Create contract (alternate)POST api/Contract?customerId={customerId}
Creates a new contract for a customer.
documented - Delete contractDELETE api/Contract/Delete/{id}
Deletes a contract by Id.
documented - Get contract by IDGET api/Contract/GetById/{id}
Retrieves a contract by Id.
documented - Get contract by ID (alternate)GET api/Contract/{id}
Retrieves a contract by Id.
documented - Get contracts by customer IDGET api/Contract/GetByCustomerId?customerId={customerId}
Retrieves contracts for a customer.
documented - Get contracts by customer ID (alternate)GET api/Contract?customerId={customerId}
Retrieves contracts for a customer.
documented - List contractsGET api/Contract/Get?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves all contracts with paging.
documented - Update contractPUT api/Contract/Put
Updates an existing contract.
documented
Kb_Item · 9
- Associate tag to KB itemPUT api/Kb_Item/AssociateTag?kbItemId={kbItemId}&tagId={tagId}
Associates a tag to a knowledge base item.
documented - Associate tag to KB item (alternate)PUT api/Kb_Item?kbItemId={kbItemId}&tagId={tagId}
Associates a tag to a knowledge base item.
documented - Create KB itemPOST api/Kb_Item/Post
Creates a new knowledge base item.
documented - Get KB item by IDGET api/Kb_Item/Get/{id}
Retrieves a knowledge base item with the given Id.
documented - List KB itemsGET api/Kb_Item/Get?offset={offset}&page_size={page_size}
Retrieves the knowledge base items by pages.
documented - List KB items (alternate)GET api/Kb_Item
Retrieves the knowledge base items list for current provider.
documented - List KB items by tagsGET api/Kb_Item/ListForTags?offset={offset}&page_size={page_size}
Retrieves the knowledge base items associated with all of the specified tags.
documented - List available KB itemsGET api/Kb_Item/GetAvailableKbItems
Retrieves the knowledge base items list for current provider.
documented - Update KB itemPOST api/Kb_Item/Post/{id}
Updates an existing knowledge base item.
documented
Asset · 8
- Create assetPOST api/Asset/CreateAsset
Creates an asset.
documented - Get asset by IDGET api/Asset/GetAssetById/{id}
Retrieves the specified asset.
documented - Get asset by ID (alternate)GET api/Asset/{id}
Retrieves the specified asset.
documented - List assets by asset categoryGET api/Asset/GetAssetsByAssetCategoryId?assetCategoryId={assetCategoryId}&offset={offset}&page_size={page_size}
Retrieves assets for a given asset category.
documented - List assets by category (alternate)GET api/Asset?assetCategoryId={assetCategoryId}&offset={offset}&page_size={page_size}
Retrieves assets by asset category.
documented - List assets by customerGET api/Asset/GetAssetsByCustomerId?customerId={customerId}&offset={offset}&page_size={page_size}
Retrieves assets for a given customer.
documented - List assets by customer (alternate)GET api/Asset?customerId={customerId}&offset={offset}&page_size={page_size}
Retrieves assets by customer.
documented - Update assetPOST api/Asset
Updates the asset.
documented
AssetCategory · 8
- Create asset categoryPOST api/AssetCategory/CreateAssetCategory
Create assets category.
documented - Create asset category (alternate)POST api/AssetCategory
Create assets category.
documented - Get asset categories by brandGET api/AssetCategory/GetAssetCategoriesById?brandId={brandId}&offset={offset}&page_size={page_size}
Retrieves asset categories by brandId.
documented - Get asset category by IDGET api/AssetCategory/GetAssetCategoryById/{id}
Retrieves specified asset category.
documented - Get asset category by ID (alternate)GET api/AssetCategory/GetAssetCategoryById1/{id}
Retrieves specified asset category.
documented - Get asset category by nameGET api/AssetCategory/GetAssetCategoryByName?name={name}
Retrieves specified asset category.
documented - Get asset category by name (alternate)GET api/AssetCategory/GetAssetCategoryByName1?name={name}
Retrieves specified asset category.
documented - List asset categories by brandGET api/AssetCategory?brandId={brandId}&offset={offset}&page_size={page_size}
Retrieves asset categories by brandId.
documented
Brand · 6
- Get brand by IDGET api/Brand/GetBrandById/{id}
Retrieves brand with specified id
documented - Get brand by ID (alternate)GET api/Brand/{id}
Retrieves brand with specified id
documented - Get brand by nameGET api/Brand/GetBrandByName?name={name}
Retrieves brand with specified name
documented - Get brand by name (alternate)GET api/Brand?name={name}
Retrieves brand with specified name
documented - Get brandsGET api/Brand/GetBrands
Retrieves all brands for provider
documented - List brandsGET api/Brand
Retrieves all brands for provider
documented
Alternate_Domain · 5
- Create alternate domainPOST api/Alternate_Domain/Post
Adds an alternate domain to a customer.
documented - Delete alternate domainDELETE api/Alternate_Domain/Delete/{id}
Removes an alternate domain from a customer.
documented - Delete alternate domain (alternate)DELETE api/Alternate_Domain/{id}
Removes an alternate domain from a customer.
documented - Get alternate domains by customerGET api/Alternate_Domain/Get?customerId={customerId}
Retrieves alternate domains for a customer.
documented - Get alternate domains by customer (alternate)GET api/Alternate_Domain?customerId={customerId}
Retrieves alternate domains for a customer.
documented
Faq_Item · 5
- Get FAQ item by IDGET api/Faq_Item/Get/{id}
Retrieves a FAQ item by Id.
documented - List FAQ itemsGET api/Faq_Item
Retrieves the FAQ items for the provider.
documented - List FAQ items (paged)GET api/Faq_Item?offset={offset}&page_size={page_size}
Retrieves FAQ items with paging.
documented - List FAQ items pagedGET api/Faq_Item/GetAvailableFaqItemsPageble?offset={offset}&page_size={page_size}
Retrieves FAQ items with paging.
documented - List available FAQ itemsGET api/Faq_Item/GetAvailableFaqItems
Retrieves FAQ items available to the current provider.
documented
News_Item · 5
- Get news item by IDGET api/News_Item/Get/{id}
Retrieves a news item by Id.
documented - List available news itemsGET api/News_Item/GetAvailableNewsItems
Retrieves news items for the provider.
documented - List news itemsGET api/News_Item
Retrieves news items for the provider.
documented - List news items (paged)GET api/News_Item?offset={offset}&page_size={page_size}
Retrieves news items with paging.
documented - List news items pagedGET api/News_Item/GetAvailableNewsItemsPagable?offset={offset}&page_size={page_size}
Retrieves news items with paging.
documented
Attachment · 4
- List attachments by ticketGET api/Attachment/GetTicketAttachments?ticketId={ticketId}
Retrieves attachments for a ticket.
documented - List attachments by ticket (alternate)GET api/Attachment?ticketId={ticketId}
Retrieves attachments for a ticket.
documented - Upload attachmentPOST api/Attachment/Upload?ticketId={ticketId}&replyId={replyId}
Uploads an attachment for a ticket or reply.
documented - Upload attachment (alternate)POST api/Attachment?ticketId={ticketId}&replyId={replyId}
Uploads an attachment for a ticket or reply.
documented
CustomForm · 4
- Get custom form by IDGET api/CustomForm/GetCustomFormById?formId={formId}
Retrieves a specified custom form.
documented - Get custom form by ID (alternate)GET api/CustomForm?formId={formId}
Retrieves a specified custom form.
documented - Get custom forms for brandGET api/CustomForm/GetCustomFormsForBrand?brandId={brandId}
Retrieves custom forms for a given brand.
documented - List custom forms for brandGET api/CustomForm?brandId={brandId}
Retrieves custom forms for a brand.
documented
Date_Format · 4
- Get date format by IDGET api/Date_Format/Get/{id}
Retrieves the date format with the specified Id.
documented - Get date format by ID (alternate)GET api/Date_Format/{id}
Retrieves the date format with the specified Id.
documented - Get date formatsGET api/Date_Format/Get
Retrieves the date formats available in the system.
documented - List date formatsGET api/Date_Format
Retrieves the date formats available in the system.
documented
Quick_Response · 4
- Apply quick response to ticketGET api/Quick_Response/Apply?quickResponseId={quickResponseId}&ticketId={ticketId}
Applies a quick response to replace placeholders in a ticket.
documented - Apply quick response to ticket (alternate)GET api/Quick_Response?quickResponseId={quickResponseId}&ticketId={ticketId}
Applies a quick response to a ticket to replace variables.
documented - List quick responsesGET api/Quick_Response/Get
Retrieves the quick responses available to the logged in user.
documented - List quick responses (alternate)GET api/Quick_Response
Retrieves the quick responses available to the logged in user.
documented
System_Status · 4
- Create system statusPOST api/System_Status/Post
Creates a new system status.
documented - Create system status (alternate)POST api/System_Status
Creates a new system status.
documented - List system statusesGET api/System_Status/Get?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves the system status associated with your provider account.
documented - List system statuses (alternate)GET api/System_Status?pageNumber={pageNumber}&pageSize={pageSize}
Retrieves the system status associated with your provider account.
documented
AgentSearch · 2
Asset_Custom_Field · 2
- Get asset custom field by asset categoryGET api/Asset_Custom_Field/GetByAssetCategoryId?assetCategoryId={assetCategoryId}
Retrieves asset custom fields for a given asset category.
documented - List asset custom fields by asset categoryGET api/Asset_Custom_Field?assetCategoryId={assetCategoryId}
Retrieves asset category fields.
documented