Skip to content
English - United States
Contact Support
  • There are no suggestions because the search field is empty.

Public API

Learn how to use the Workglue Public API to connect Workglue to other applications and build custom integrations.

The Workglue Public API lets developers and technical users read and write Workglue data programmatically. Use it to connect Workglue to other applications, build custom integrations, or automate workflows that go beyond what Zapier and the built-in integrations cover. The Public API is authenticated with your Workglue Account API Key and is documented in a dedicated developer documentation site with live "Try now" cURL examples for every endpoint.

Workglue Account API Key vs User Personal API Key

Workglue uses two different API keys for different purposes. Make sure you are using the right one for what you are building.

  • Workglue Account API Key. A company-level key managed on the Integrations tab in My Account. Used for company-wide integrations like PaintScout, the system-level Zapier integration, and the Public API. Actions taken with this key are attributed to the account, not to an individual user.
  • User Personal API Key. A user-level key managed on the Profile tab in My Account. Used for personal integrations like user-level Zapier zaps and personal calendar sync. Actions taken with this key are attributed to the individual user.

The Public API uses the Workglue Account API Key.

Where to find the Public API

  1. Select My Account in the left navigation.
  2. Select the Integrations tab.
  3. Scroll to the Workglue Public API section.

From this section you can create and manage your Account API Key and open the live developer documentation.

How to create your Account API Key

If no key has been created yet, the section shows the message "No Workglue Account API Key has been created yet."

  1. Select Create Account API Key.
  2. The key is generated and displayed in the section.

Once created, the key is used to authenticate every request your integration makes to the Public API.

How to view or copy your Account API Key
  1. Select the eye icon to reveal the key.
  2. Select the copy icon to copy the key to your clipboard.

The Created date shows when the key was first generated. The Last Used date shows the most recent time the key was used to authenticate a request.

How to reset your Account API Key

Resetting generates a brand new Account API Key and invalidates the old one. Use this if you suspect the key has been compromised or if you want to rotate credentials.

  1. Select Reset.
  2. Update any integrations that used the old key with the new one.

Any integrations using the old Account API Key will stop working as soon as you reset. This includes PaintScout, the system-level Zapier integration, and any custom integrations built on the Public API. Have your integration settings ready to update before you reset.

How to revoke your Account API Key

Revoking permanently disables the Account API Key without generating a new one. Use this if you no longer need API access at the account level.

  1. Select Revoke.

After revoking, any integrations using the key will stop working. You can generate a new key at any time by selecting Create Account API Key.

Developer documentation

The full Workglue Public API documentation is hosteion site. Select Documentation from the Workglue Public API section to open it.

The documentation includes the base URL, authentication details, every available endpoint organized by resource, request and response examples, rate limit details, and a Try now button on each endpoint that generates a copy-ready cURL command with your Account API Key auto-filled.

Resources

The Public API exposes the following resources. Each resource has a list endpoint and a single record endpoint.

  • Jobs. Jobs in your Workglue account, including both Active and Closed stages. Sales-stage Opportunities are also accessed through this resource.
  • Customers. Customer Accounts in your Workglue account.
  • Contacts. Contacts attached to Customer Accounts and Jobs.
  • Job Stages. The pipeline stages configured for your account.
  • Job Types. The Job Types configured for your account.
  • Employees. Users and Subs in your Workglue account.

Refer to the developer documentation for the full list of endpoints, supported HTTP methods, request and response schemas, and additional resources.

Supported HTTP methods

The Public API supports standard HTTP methods.

  • GET. Read data from Workglue.
  • POST. Create new records in Workglue.
  • PATCH. Update existing records in Workglue.
  • DELETE. Remove records from Workglue.

Not every resource supports every method. Refer to the developer documentation for which methods are available on each endpoint.