large_5_Burger-Kings-expansion-1024x768.jpg

medium_5_Burger-Kings-expansion-1024x768.jpg

small_5_Burger-Kings-expansion-1024x768.jpg

thumbnail_5_Burger-Kings-expansion-1024x768.jpg

5_Burger-Kings-expansion-1024x768.jpg

Learn how Wavin connected with their end-customers via a branded loyalty app and grew their user base 17x in the first 6 months.

medium_AkzoNobel.png

small_AkzoNobel.png

thumbnail_AkzoNobel.png

AkzoNobel.png

Connect your loyalty program in Teamwork Desk without researching its API, registering in a developer program, and getting your application approved. We take care of authentication, secure credentials storage, and token refreshes so you don't have to.

Teamwork Desk

Get the latest announcement given compatible permissions.

The following values are allowed in the <a>filter</a> query parameter:
<ul>
<li>id</li>
<li>name</li>
</ul>
The following values are allowed in the orderBy query parameter:
<ul>
<li>id
</li>
<li>name
<pre><code> The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
</code></pre>
</li>
<li>users
</li>
<li>all
</li>
</ul>

Get a paginated list of appfeatures.

The following values are allowed in the <a>includes</a> query parameter:
<ul>
<li>users</li>
<li>all</li>
</ul>

Get a single appfeature by id.

The following values are allowed in the <a>filter</a> query parameter:
<ul>
<li>id</li>
<li>appfeatureId</li>
<li>value</li>
<li>comment</li>
<li>createdAt</li>
<li>updatedAt</li>
<li>deletedAt</li>
<li>state</li>
</ul>
The following values are allowed in the orderBy query parameter:
<ul>
<li>id
</li>
<li>appfeatureId
</li>
<li>value
</li>
<li>comment
</li>
<li>createdAt
</li>
<li>updatedAt
</li>
<li>deletedAt
</li>
<li>state
<pre><code> The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
</code></pre>
</li>
<li>users
</li>
<li>all
</li>
</ul>

Get a paginated list of appfeaturesinstallations.

Get a single appfeaturesinstallation by id.

The following values are allowed in the <a>filter</a> query parameter:
<ul>
<li>createdAt</li>
<li>updatedAt</li>
<li>deletedAt</li>
<li>state</li>
</ul>
The following values are allowed in the orderBy query parameter:
<ul>
<li>createdAt
</li>
<li>updatedAt
</li>
<li>deletedAt
</li>
<li>state
<pre><code> The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
</code></pre>
</li>
<li>users
</li>
<li>appsettings
</li>
<li>all
</li>
</ul>

Get a paginated list of apps.

Update an app setting

Install an app

Uninstall an app

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- appsettings
- all

Get a single app by id.

Get a background job by id.

Delete a backgroundjob.

Get an installation level background job.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- description
- isDefault
- timezoneId
- timezone_name
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  name
-  description
-  isDefault
-  timezoneId
-  timezone_name
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- businesshoursschedules
- businesshoursholidays
- triggers
- all

Get a paginated list of businesshours.

Create a new businesshour.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- businesshoursschedules
- businesshoursholidays
- triggers
- all

Get a single businesshour by id.

Delete a businesshour.

Update all the given properties for this resource. Any omitted properties
will be unchanged.

Update a businesshour.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- businesshours_id
- name
- startDate
- endDate
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  businesshours_id
-  name
-  startDate
-  endDate
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- all

Get a paginated list of businesshoursholidays.

Create a new businesshoursholiday.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- all

Get a single businesshoursholiday by id.

Delete a businesshoursholiday.

Update a businesshoursholiday.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- businesshours_id
- day
- startHour
- endHour
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  businesshours_id
-  day
-  startHour
-  endHour
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- all

Get a paginated list of businesshoursschedules.

Create a new businesshoursschedule.

Get a single businesshoursschedule by id.

Delete a businesshoursschedule.

Update a businesshoursschedule.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- reply
- inbox
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  name
-  reply
-  inbox
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- inboxes
- files
- all

Get a paginated list of cannedresponses.

Create a new cannedresponse.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- inboxes
- files
- all

Get a single cannedresponse by id.

Delete a cannedresponse.

Update a cannedresponse.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- email
- details
- industry
- website
- avatarPath
- permission
- kind
- customersCount
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  name
-  email
-  details
-  industry
-  website
-  avatarPath
-  permission
-  kind
-  customersCount
-  createdAt
-  updatedAt
-  deletedAt
-  state
-  domains.id
-  domains.name
-  inboxes.id
-  website
-  email
-  address
-  address.country
-  customersCount
-  phones
-  name


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- domains
- addresses
- phones
- sociallinks
- customers
- all

Get a paginated list of companies.

Create a new company.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- domains
- addresses
- phones
- sociallinks
- customers
- all

Get a single company by id.

Delete a company.

Update all the given properties for this resource. Any omitted properties
will be unchanged.  Customers can be added to a company via the 'includes:
customers' field.  Customers can be removed by specifying 'delete: true' on
the `customers: []` relationship.

Update a company.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- email
- details
- industry
- website
- avatarPath
- permission
- kind
- customersCount
- createdAt
- updatedAt
- deletedAt
- state

Delete multiple companies.

Generates a job which will execute
the import process in the background.

Imports companies to an installation.

All organization fields on the customers of an installation will be migrated
to become companies.

Migrates organizations of an installation to companies.

Update all the given properties for matching resources. Any omitted properties
will be unchanged.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- name
- email
- details
- industry
- website
- avatarPath
- permission
- kind
- customersCount
- createdAt
- updatedAt
- deletedAt
- state

Update multiple companies.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- token
- theme
- inboxFieldName
- accentColor
- triggerColor
- position
- liveChatWelcomeMessage
- isLiveChatEnabled
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  name
-  token
-  theme
-  inboxFieldName
-  accentColor
-  triggerColor
-  position
-  liveChatWelcomeMessage
-  isLiveChatEnabled
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- helpdocs
- inboxes
- all

Get a paginated list of contactforms.

Create a new contactform.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- helpdocs
- inboxes
- all

Get a single contactform by id.

Delete a contactform.

Update a contactform.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- token
- theme
- inboxFieldName
- accentColor
- triggerColor
- position
- liveChatWelcomeMessage
- isLiveChatEnabled
- createdAt
- updatedAt
- deletedAt
- state

Delete multiple contactforms.

Update all the given properties for matching resources. Any omitted properties
will be unchanged.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- name
- token
- theme
- inboxFieldName
- accentColor
- triggerColor
- position
- liveChatWelcomeMessage
- isLiveChatEnabled
- createdAt
- updatedAt
- deletedAt
- state

Update multiple contactforms.

authenticated via socket token.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- contactId
- userId
- message
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  contactId
-  userId
-  message
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- contacts
- customers
- files
- all

Get a paginated list of conversationmessages.  This is a public endpoint,

Delete a conversationmessage.

Update a conversationmessage.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- contactId
- userId
- message
- createdAt
- updatedAt
- deletedAt
- state

Delete multiple conversationmessages.

Update all the given properties for matching resources. Any omitted properties
will be unchanged.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- contactId
- userId
- message
- createdAt
- updatedAt
- deletedAt
- state

Update multiple conversationmessages.

This endpoint is used by pusher to send bulk events to desk via webhooks.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- contactId
- token
- ticket_id
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  contactId
-  token
-  ticket_id
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- contacts
- customers
- conversationmessages
- all

Get a paginated list of conversations.

3rd party user to join a room.  Because we only allow joinging rooms on
authentication we can return a token that will be used as the room name and
will allow a lookup in the conversations table to find history.

Create a new conversation via the pusher API.  This authorizes the current

Converts a conversation to a ticket

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- contacts
- customers
- conversationmessages
- all

Get a single conversation by id.

Delete a conversation.

Update a conversation.

Restore a deleted conversation by id.

Get authorized on every requested conversation if it is active

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- contactId
- token
- ticket_id
- createdAt
- updatedAt
- deletedAt
- state

Delete multiple conversations.

Rejoin a conversation.  This often happens when the customer refreshes the

Generates a new token for a conversation

a match on the installation and token


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- contacts
- customers
- conversationmessages
- all

Get a single conversation by token.  This is a public endpoint that requires

Update all the given properties for matching resources. Any omitted properties
will be unchanged.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- contactId
- token
- ticket_id
- createdAt
- updatedAt
- deletedAt
- state

Update multiple conversations.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- enabled
- canSeeAgent
- canSeeLastRead
- canSetPriority
- canSeeTags
- canEditTags
- canCloseTicket
- canSetType
- bodyColor
- bodyLinks
- bodyText
- button
- buttonText
- search
- searchText
- header
- headerLinks
- styleHelpDocsId
- language
- customDomain
- inboxFieldName
- sendCustomerWelcome
- customerWelcomeSubject
- customerWelcomeEmail
- icon
- stylesheetURL
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  enabled
-  canSeeAgent
-  canSeeLastRead
-  canSetPriority
-  canSeeTags
-  canEditTags
-  canCloseTicket
-  canSetType
-  bodyColor
-  bodyLinks
-  bodyText
-  button
-  buttonText
-  search
-  searchText
-  header
-  headerLinks
-  styleHelpDocsId
-  language
-  customDomain
-  inboxFieldName
-  sendCustomerWelcome
-  customerWelcomeSubject
-  customerWelcomeEmail
-  icon
-  stylesheetURL
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- inboxes
- helpdocs
- all

Get all customerportals.

created then this will exit with a bad request error.  Future versions will
allow for multiple portals to be created for customer-specific branding.

Create a new customerportal.  If the installation already has a portal

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- inboxes
- helpdocs
- all

Get a single customerportal by id.

Delete a customerportal.

Patch a customerportal by id.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- firstName
- lastName
- organization
- verifiedEmail
- permission
- addMethod
- linkedinURL
- facebookURL
- twitterHandle
- numTickets
- jobTitle
- phone
- mobile
- address
- externalId
- avatarURL
- trusted
- welcomeEmailSent
- password
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  companies.name
-  email
-  contacts.value
-  id
-  firstName
-  lastName
-  organization
-  verifiedEmail
-  permission
-  addMethod
-  linkedinURL
-  facebookURL
-  twitterHandle
-  numTickets
-  jobTitle
-  phone
-  mobile
-  address
-  externalId
-  avatarURL
-  trusted
-  welcomeEmailSent
-  password
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- companies
- customerwelcomeemails
- contacts
- all

Get a paginated list of customers.

Create a new customer.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- companies
- customerwelcomeemails
- contacts
- all

Get a single customer by id.

Delete a customer.

Update all the given properties for this resource. Any omitted properties
will be unchanged.  Customers can be added to a customer via the 'includes:
customers' field.  Customers can be removed by speecifying 'delete: true' on
the `customers: []` relationship.

Update a customer.

creation as long as the customer portal is enabled and the welcome email
feature is turned on.

Resend the welcome email to customers.  This email is sent to customers on

Restore a deleted customer by id.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- firstName
- lastName
- organization
- verifiedEmail
- permission
- addMethod
- linkedinURL
- facebookURL
- twitterHandle
- numTickets
- jobTitle
- phone
- mobile
- address
- externalId
- avatarURL
- trusted
- welcomeEmailSent
- password
- createdAt
- updatedAt
- deletedAt
- state

Delete multiple customers.

Update all the given properties for matching resources. Any omitted properties
will be unchanged.


            The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:


- id
- firstName
- lastName
- organization
- verifiedEmail
- permission
- addMethod
- linkedinURL
- facebookURL
- twitterHandle
- numTickets
- jobTitle
- phone
- mobile
- address
- externalId
- avatarURL
- trusted
- welcomeEmailSent
- password
- createdAt
- updatedAt
- deletedAt
- state

Update multiple customers.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- agentLabel
- customerLabel
- description
- displayOrder
- kind
- customerRequired
- agentRequired
- addToNewInboxes
- enabled
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  agentLabel
-  customerLabel
-  description
-  displayOrder
-  kind
-  customerRequired
-  agentRequired
-  addToNewInboxes
-  enabled
-  createdAt
-  updatedAt
-  deletedAt
-  state
-  tickets.id
-  inboxes.id


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- customfieldoptions
- customfieldapps
- all

Get a paginated list of customfields.

Create a new customfield.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- customfieldoptions
- customfieldapps
- all

Get a single customfield by id.

Delete a customfield.

Update a customfield.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- token
- platform
- app
- lastRegisteredAt
- version
- createdAt
- updatedAt
- state

The following values are allowed in the orderBy query parameter:
-  platform
-  registered
-  id
-  token
-  app
-  lastRegisteredAt
-  version
-  createdAt
-  updatedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- all

Get a paginated list of devices.

Get a single device by id.

Get a paginated list of exports.

Create a new export.

Get a single export by id.

Download the completed export. (redirects to S3)

List filter fields for user.

Update filter fields for user.

The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:
- users
- tickets
- happinessratingoptions
- all

Get inbox settings specific to the ticket being rated.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- color
- score
- annotation
- createdAt
- updatedAt
- deletedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  name
-  color
-  score
-  annotation
-  createdAt
-  updatedAt
-  deletedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- all

Get a paginated list of happinessratingoptions.

Get a single happinessratingoption by id.

The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- comment
- deletedReason
- deletedAt
- ticket
- happinessratingoption
- createdAt
- updatedAt
- state

The following values are allowed in the orderBy query parameter:
-  id
-  comment
-  deletedReason
-  deletedAt
-  ticket
-  happinessratingoption
-  createdAt
-  updatedAt
-  state


            The following values are allowed in the [includes](/docs/desk/8da90e1872879-relationships-and-includes) query parameter:


- users
- tickets
- happinessratingoptions
- all

Get a paginated list of happinessratings.

Get a single happinessrating by id.

Seamlessly integrate loyalty with Teamwork Desk to streamline your business.

White Label Loyalty + Teamwork Desk integration

About Teamwork Desk

Similar Integrations

Intercom

SuperOffice

Zoho Desk

Kustomer

Benefits of White Label Loyalty + Teamwork Desk

Integrate now!

Automate desired actions with Teamwork Desk