Changelog ​

2026 ​

APR ​

LAUNCH Users endpoints

• Added endpoints for listing users and retrieving a user.
• Added endpoint for listing a user's group memberships.
• User responses now include company_role and urls.group_memberships.
• User group membership responses include user_id, user_group_id, and urls.user_group.

LAUNCH User groups endpoints

• Added endpoints for listing user groups and retrieving a user group.
• Added endpoint for listing users in a user group.
• User group responses include users_count, owner, and urls.users.
• User objects returned from user group users include company_role.

FEATURE Lookup lists by external_id

• Added external parameter to retrieve, update, and delete list endpoints.
• Added external_list parameter to list, create, and delete list membership endpoints.
• Allows lookup of lists by their external_id instead of the id assigned by Workshop.

CHANGE GET /v1/lists ordering and created_at

• Lists are now returned in reverse chronological order (newest created_at first).
• Added created_at to list objects in both list and retrieve responses.

CHANGE POST /v1/lists returns the list object

• Create a list now returns the created list resource (same shape as retrieve a list) instead of only a success message.

FEATURE Set creator_id and description on lists

• Added creator_id and description fields to the list object in all list responses.
• Create a list and Update a list now accept creator_id and description parameters. creator_id must be the ID of a user in your company.
• Supply null on update to clear either field.

FEATURE contact_external_id on list memberships

• List list memberships responses now include contact_external_id for each membership.

FEATURE Recipient delivery_status

• List recipients of an email responses now include delivery_status for each recipient, reporting whether the email was delivered, rejected, sending, in_progress, or has no data available yet (null).

2025 ​

AUG ​

v1.2 ​

CHANGE Breaking changes

• Support was added for emails to be associated with multiple campaigns
• Requests using Version 1.2 or later will include the campaigns property as an array of campaigns when retrieving an email
• Requests using Version 1.1 and earlier will continue to include a campaign property with a single campaign when retrieving an email

CHANGE Update contact attributes

• No longer required to supply the entire attributes object when updating a contact.
• Keys in the attributes object in the request payload will overwrite existing attributes for the contact. Other attributes not specified in the request will remain unchanged.
• To remove a key from a contact's attributes, you must supply a null value for that key.

FEATURE Lookup contacts by external_id

• Added external parameter to retrieve, update, and delete endpoints.
• Allows lookup of contacts by their external_id instead of the id that is assigned by Workshop.

JUN ​

FEATURE Web visits endpoint

• Added endpoint for retrieving Web Visits of an Email.

MAY ​

v1.1 ​

CHANGE Breaking changes

• Paginated endpoints previously used object: "list" in their response to indicate that the response data was a list of records. This has been changed to object: "array" to avoid confusion with Workshop Lists.
• Requests using Version 1.1 or later will see object: "list" used for responses containing a Workshop List record.
• Requests using Version 1.0 will see object: "list" used both for paginated responses and for responses containing a Workshop List record.

CHANGE Pagination

• The limit parameter now defaults to 50 instead of 5. Page size can still be set between 1 and 100, as before.

LAUNCH Lists endpoints

• Added endpoints for retrieving Lists and memberships.
• Added endpoints for creating, updating, and deleting lists for those using the API as their sync source.
• Added endpoints for adding and removing contacts as members of a list.

FEB ​

v1.0 ​

LAUNCH Contacts endpoints

• Added endpoints for retrieving Contacts.
• Added endpoints for creating, updating, and deleting contacts for those using the API as their sync source.

LAUNCH API versioning

• The API key can now be pinned to a specific version.
• The Workshop-Version header can be used to override the API key's pinned version.
• See the Versioning documentation for more information.

CHANGE Pagination strategy

• The Pagination strategy was updated to use cursor-based pagination instead of offset-based pagination. This change was made to ensure consistency of results when paging through large datasets.
• See the Pagination documentation for more information.

2024 ​

Prior to 2025, the API was not versioned. It only included GET endpoints for retrieving detailed analytics data from Workshop.

FEATURE Emails endpoints

• List Emails
• Retrieve an Email
• List Recipients of an Email
• List Opens of an Email
• List Links in an Email
• List Clicks in an Email

FEATURE Campaigns endpoints

• List campaigns
• Retrieve a campaign
• List emails within a campaign

FEATURE Links endpoints

• Retrieve a link
• List clicks on a link