Roles

The role object

A named set of permissions that can be assigned to users to control what they can access.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

  • admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
  • user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
  • scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
  • sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

Always returned as null in this endpoint.
default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

Always returned as null in this endpoint.
brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.
portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions granted by this role, in {permission}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate API KeyAPI KeyGETList API KeysAPI KeyGETRetrieve API KeyAPI KeyPOSTRotate API KeyAPI KeyGETList Request LogsRequest LogGETRetrieve Request LogRequest LogGETList Audit EventsAudit EventGETRetrieve Audit EventAudit EventPOSTBulk Upsert UnitsUnitsPOSTBulk Upsert Unit GroupsUnit GroupsPOSTCreate AgentAgentPATCHUpdate AgentAgentGETList AgentsAgentGETRetrieve AgentAgentPUTUpdate Agent StatusAgentGETList NotificationsNotificationsGETRetrieve NotificationNotificationsPOSTDismiss NotificationNotificationsPOSTMark Notification ReadNotificationsPOSTMark Notification SeenNotificationsPOSTCreate ConversationConversationsPATCHUpdate ConversationConversationsGETList ConversationsConversationsGETRetrieve ConversationConversationsPOSTLink RecordConversationsGETList LinksConversationsPOSTArchive ConversationConversationsPOSTAssign CaseConversationsPOSTHide ConversationConversationsPOSTLeave ConversationConversationsPOSTMute ConversationConversationsPOSTMark Conversation ReadConversationsPOSTRedact ConversationConversationsPOSTReport ConversationConversationsPOSTSet Legal HoldConversationsPOSTSet Case StatusConversationsPOSTUnarchive ConversationConversationsPOSTUnhide ConversationConversationsPOSTUnmute ConversationConversationsPATCHUpdate Reply DraftMessagesPOSTSend MessageMessagesGETList MessagesMessagesPOSTApprove And Send Reply DraftMessagesPOSTCancel Scheduled MessageMessagesPOSTReject Reply DraftMessagesPOSTAdd ParticipantConversation ParticipantsPOSTUpdate Participant RoleConversation ParticipantsPOSTCreate Messaging GroupMessaging GroupsPATCHUpdate Messaging GroupMessaging GroupsGETList Messaging GroupsMessaging GroupsGETRetrieve Messaging GroupMessaging GroupsPOSTAdd Messaging Group MemberMessaging GroupsDELETERemove Messaging Group MemberMessaging GroupsPOSTBlock UserMessage BlocksGETList BlocksMessage BlocksGETList Messaging ContactsMessaging ContactsPOSTCreate Email InboxEmail InboxesPATCHUpdate Email InboxEmail InboxesGETList Email InboxesEmail InboxesGETGet Email InboxEmail InboxesPOSTTrigger Agent RunAgent RunsGETList Agent RunsAgent RunsGETRetrieve Agent RunAgent RunsPOSTCancel Agent RunAgent RunsPOSTContinue Agent RunAgent RunsPOSTRetry Agent RunAgent RunsPOSTExport Price ListAccount PricesPOSTCreate Account UserAccount UsersPATCHUpdate Account UserAccount UsersGETList Account UsersAccount UsersGETRetrieve Account UserAccount UsersPOSTBulk Upsert PropertiesPropertiesPOSTBulk Upsert Item CategoriesItem CategoriesPOSTBulk Upsert MaterialsMaterialsPOSTBulk Upsert PartsPartsGETList Email LogsEmail LogsGETRetrieve Email LogEmail LogsPOSTCreate CustomerCustomersPATCHUpdate CustomerCustomersGETList CustomersCustomersGETRetrieve CustomerCustomersPOSTMerge CustomersCustomersPOSTFind Contact by EmailContactsPOSTBulk Upsert Product LinesProduct LinesPOSTBulk Upsert ProductsProductsGETRetrieve JobJobsPOSTCancel JobJobsPOSTCreate Machine Downtime EventMachine DowntimePATCHUpdate Machine Downtime EventMachine DowntimeGETList Machine Downtime EventsMachine DowntimeGETRetrieve Machine Downtime EventMachine DowntimePOSTGenerate Production ScheduleProduction SchedulesGETList Production SchedulesProduction SchedulesGETRetrieve Current Production ScheduleProduction SchedulesGETRetrieve Production ScheduleProduction SchedulesGETList Production Schedule DeviationsProduction SchedulesPUTArchive Production ScheduleProduction SchedulesPUTPublish Production ScheduleProduction SchedulesPUTRegenerate Production ScheduleProduction SchedulesPOSTRelease Production Schedule WeekProduction SchedulesPOSTCreate Sales OrderSales OrdersPATCHUpdate Sales OrderSales OrdersGETList Sales OrdersSales OrdersGETRetrieve Sales OrderSales OrdersPUTClose Sales OrderSales OrdersPOSTCreate Production Run from Sales OrderSales OrdersPUTIssue Sales OrderSales OrdersPUTReopen Sales OrderSales OrdersPUTUnissue Sales OrderSales OrdersPOSTBulk Upsert LocationsLocationPOSTCreate RoleRolesPATCHUpdate RoleRolesGETList RolesRolesGETRetrieve RoleRolesDELETEDelete RoleRoles