Embedded APIResources

Workato API - Manage Customers

ENDPOINT AVAILABILITY

The endpoints in this guide are Embedded Vendor APIs and require the oem_vendor privilege. Contact your Workato representative to enable this privilege in your account.

The Managed Users resource provides the ability to programmatically manage customers.

Quick Reference

DEPRECATED ENDPOINTS

Deprecated endpoints continue to work, but are not be updated after deprecation.

The Managed Users resource contains the following endpoints:

TypeResourceDescription
GET/api/managed_usersGet list of customer accounts.
POST/api/managed_usersCreate customer account.
GET/api/managed_users/usageGet monthly usage.
DELETE/api/managed_users/:managed_user_idDeprecated. Delete customer account.
GET/api/managed_users/:managed_user_idGet customer account.
PUT/api/managed_users/:managed_user_idUpdate customer account.
GET/api/managed_users/:managed_user_id/membersGet list of customer account members.
POST/api/managed_users/:managed_user_id/membersAdd member to customer account.
DELETE/api/managed_users/:managed_user_id/members/:member_idRemove member from customer account.
GET/api/managed_users/:managed_user_id/members/:member_idGet customer account member.
PUT/api/managed_users/:managed_user_id/members/:member_idDeprecated. Update customer account member.
POST/api/managed_users/:managed_user_id/environmentsProvision Environments for an existing customer.
POST/api/v2/managed_users/statistics/usageRetrieves usage metrics for specified customer workspaces within a defined time frame, including task usage, recipe counts, and counts of successful and failed jobs.
POST/api/v2/managed_users/statistics/connection_usageRetrieve connection-based usage metrics for specified customer workspaces.
POST/api/v2/managed_users/statistics/usageRetrieves usage metrics for specified customer workspaces within a defined time frame, including task usage, recipe counts, and counts of successful and failed jobs.