Request

APIDescription
GET api/request/provider/{guid}

Retrieves the request for the given key and GUID.

GET api/Request?guid={guid}

Retrieves the request for the given key and GUID.

Authenticate

APIDescription
GET api/ResetPassword?domain={domain}&email={email}

Attempts to reset a users password.

GET api/Authenticate?domain={domain}&username={username}&password={password}

Attempts a login to create an access token necessary to access protected resources.

GET api/Authenticate?domain={domain}&email={email}

Attempts to reset a users password.

APIDescription
GET api/search/contacts-and-tickets?q={q}

Searches all contacts and tickets based on the given query.

GET api/search/contacts?q={q}

Searches all contacts based on the given query.

GET api/search/members?q={q}

Searches all members based on the given query.

GET api/search/agents?q={q}

Searches all agents based on the given query.

Brand

APIDescription
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

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

APIDescription
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?brandId={brandId}

Retrieves custom forms for specified brand

GET api/CustomForm?formId={formId}

Retrieves specified custom form

Report

APIDescription
POST api/reports/timesheet

Generates Timesheet report for agents

POST api/Report

Generates Timesheet report for agents

Quick_Response

APIDescription
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

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

APIDescription
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/{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

APIDescription
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

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/stats

Retrieves support ticket count stats.

GET api/support_ticket/advanced_stats

Retrieves support ticket count stats in advanced mode.

GET api/support_ticket/unassigned

Retrieves all unassigned support tickets.

GET api/support_ticket/unassigned?pageNumber={pageNumber}&pageSize={pageSize}

Retrieves all unassigned support tickets by pages.

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

Retrieves all unresolved support tickets.

GET api/support_ticket/unresolved?pageNumber={pageNumber}&pageSize={pageSize}&useGroupFilter={useGroupFilter}

Retrieves all unresolved 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_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?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}?pageNumber={pageNumber}&pageSize={pageSize}

Retrieves company tickets with custom fields by pages.

Alternate_Domain

APIDescription
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/{id}

Removes an alternate domain from a customer.

GET api/Alternate_Domain?customerId={customerId}

Retrieves the alternate domains associated with a customer.

EncryptedAuthProvider

APIDescription
POST api/auth/contact_token

Retrieves all of your contacts.

POST api/EncryptedAuthProvider

Retrieves all of your contacts.

Me

APIDescription
GET api/me/provider

Retrieves the provider of the logged in user.

GET api/me/provider/id

Retrieves the Id of the provider of the logged in user.

PUT api/Me

Updates the currently logged in agent.

Product

APIDescription
GET api/product/for_brand/{brandId}

Retrieves the products available in the system.

GET api/Product?brandId={brandId}

Retrieves the products available in the system.

Provider

APIDescription
POST api/provider/provision

Requests a new provider.

POST api/provider/resellersignup

Requests a new resseller.

GET api/provider/list

Retrieves all existing service providers.

GET api/Provider/{id}

Determines the availability of a domain.

GET api/Provider

Retrieves all existing service providers.

Individual

APIDescription
POST api/individual/{contactid}

Deletes the 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

Customer

APIDescription
POST api/customer/{customerid}

Deletes the customer

GET api/Customer/domain?domain={domain}

Retrieves the customer with the specified Domain and Name.

GET api/Customer

Retrieves the customers associated with your provider account.

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?customerid={customerid}

Deletes the customer

POST api/Customer

Creates a new customer.

POST api/Customer/{id}

Updates an existing customer.

Faq_Item

APIDescription
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

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

APIDescription
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?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

APIDescription
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

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

APIDescription
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

POST api/AssetCategory

Create assets category

Asset

APIDescription
GET api/asset/get_by_id/{id}

Retrieves specified asset

POST api/asset/create

Create asset

GET api/Asset/{id}

Retrieves specified asset

POST api/Asset

Create asset

Pricing

APIDescription
POST api/pricing/default_pricings

Sets default pricings for plans

GET api/pricing/pricings_for_plan/{plan_name}

Retrieves all pricings for the specified plan

GET api/pricing/pricing_for_provider/{provider_id}

Retrieves a pricings for the specified service provider

PUT api/pricing/pricing_for_provider/{provider_id}

Updates the pricings for the specified service provider

GET api/Pricing?provider_id={provider_id}

Retrieves a pricings for the specified service provider

PUT api/Pricing?provider_id={provider_id}

Updates the pricings for the specified service provider

GET api/Pricing?plan_name={plan_name}

Retrieves all pricings for the specified plan

Invoices

APIDescription
POST api/invoices/reserve_next_id

Retrieves the invoice

GET api/invoices/latest_existing_id

Retrieves the last invoice

GET api/Invoices

Retrieves the last invoice

POST api/Invoices

Retrieves the invoice

Date_Format

APIDescription
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

APIDescription
GET api/Ticket_Type

Retrieves all of the ticket types in the system.

Group

APIDescription
GET api/Group?pageNumber={pageNumber}&pageSize={pageSize}

Retrieves the groups associated with your provider account.

Customer_Custom_Field

APIDescription
GET api/Customer_Custom_Field/{id}

Retrieves the specified customers custom fields.

Priority

APIDescription
GET api/Priority

Retrieves all of the priorities available in the system.

AgentSearch

APIDescription
GET api/AgentSearch?email={email}

Retrieves the contacts by email.

Source

APIDescription
GET api/Source

Retrieves all of the sources in the system.

Time_Format

APIDescription
GET api/Time_Format

Retrieves the time formats available in the system.

Support_Ticket_Custom_Field

APIDescription
GET api/Support_Ticket_Custom_Field/{id}

Retrieves the specified tickets custom fields.

Forms_Custom_Field

APIDescription
GET api/Forms_Custom_Field

Retrieves the forms custom fields.

Agent

APIDescription
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.

Echo

APIDescription
GET api/Echo

Echo action for the testing API work

Support_Ticket_Zapier

APIDescription
POST api/Support_Ticket_Zapier?email_customer={email_customer}&disableNotification={disableNotification}

Create ticket from zapier

Status

APIDescription
GET api/Status

Retrieves all of the statuses in the system.

Tag

APIDescription
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.