A companion to iPaaS.com Permissions Reference. That article describes what each permission controls; this one lists the specific REST API endpoints each permission governs, plus the endpoints available to every user regardless of role.

How to read this: Permissions are grouped and ordered exactly as in the Permissions Reference. Under each permission is the set of API routes it secures. A route shows its HTTP method and its resolved path (for example POST /v2/Product). Granting a permission on a role grants that role access to every endpoint listed beneath it: Create grants POST access, Read, GET, etc). For the full API surface, see The iPaaS.com REST API: Swagger/OpenAPI Reference Guide.

Infrastructure health-check routes (/Health, /Hello) exist on each service and are listed once under Available to All Users.

Data Types

These permissions control access to iPaaS.com's canonical data records. Each maps to a data model in the platform; see Data Domains & Mapping Collection Types.

Products

Product

Method	Endpoint
GET	`/v2/Catalog/Product/{id}`
GET	`/v2/Catalog/Products`
POST	`/v2/Catalog/Product`
PUT	`/v2/Catalog/Product/{id}`
PUT	`/v2/Catalog/Product/Reactivate/{id}`
DELETE	`/v2/Catalog/Product/{id}`

Product Variant

Method	Endpoint
GET	`/v2/Catalog/Product/Variant/{id}`
GET	`/v2/Catalog/Product/Variants`
PUT	`/v2/Catalog/Product/Variant/{id}`
PUT	`/v2/Catalog/Product/Variant/Reactivate/{id}`
DELETE	`/v2/Catalog/Product/Variant/{id}`

Product Category

Method	Endpoint
GET	`/v2/Catalog/Categories`
GET	`/v2/Catalog/Category/{id}`
GET	`/v2/Catalog/CategorySets`
GET	`/v2/Catalog/CategorySet/{id}`
GET	`/v2/Catalog/Product/Category/Assignment/{id}`
GET	`/v2/Catalog/Product/Variant/Category/Assignment/{id}`
POST	`/v2/Catalog/Category`
POST	`/v2/Catalog/CategorySet`
POST	`/v2/Catalog/Product/Category/Assignment`
POST	`/v2/Catalog/Product/Variant/Category/Assignment`
PUT	`/v2/Catalog/Category/{id}`
PUT	`/v2/Catalog/Category/Reactivate/{id}`
PUT	`/v2/Catalog/CategorySet/{id}`
PUT	`/v2/Catalog/CategorySet/Reactivate/{id}`
DELETE	`/v2/Catalog/Category/{id}`
DELETE	`/v2/Catalog/CategorySet/{id}`
DELETE	`/v2/Catalog/Product/Category/Assignment/{id}`
DELETE	`/v2/Catalog/Product/Variant/Category/Assignment/{id}`

Product Option

Method	Endpoint
GET	`/v2/Catalog/Option/{id}`
POST	`/v2/Catalog/Option`
PUT	`/v2/Catalog/Option/{id}`
PUT	`/v2/Catalog/Option/Reactivate/{id}`
DELETE	`/v2/Catalog/Option/{id}`

Product Unit

Method	Endpoint
GET	`/v2/Catalog/Unit/{id}`
POST	`/v2/Catalog/Unit`
PUT	`/v2/Catalog/Unit/{id}`
PUT	`/v2/Catalog/Unit/Reactivate/{id}`
PUT	`/v2/Catalog/Variant/Unit/{id}`
DELETE	`/v2/Catalog/Unit/{id}`

Product Inventory

Method	Endpoint
GET	`/v2/Catalog/Inventory/{id}`
POST	`/v2/Catalog/Inventory`
PUT	`/v2/Catalog/Inventory/{id}`
PUT	`/v2/Catalog/Inventory/Reactivate/{id}`
DELETE	`/v2/Catalog/Inventory/{id}`

Product Variant Inventory

Method	Endpoint
GET	`/v2/Catalog/Variant/Inventory/{id}`
POST	`/v2/Catalog/Variant/Inventory`
PUT	`/v2/Catalog/Variant/Inventory/{id}`
PUT	`/v2/Catalog/Variant/Inventory/Reactivate/{id}`
DELETE	`/v2/Catalog/Variant/Inventory/{id}`

Product Variant Option

Method	Endpoint
GET	`/v2/Catalog/Variant/Option/{id}`
POST	`/v2/Catalog/Variant/Option`
PUT	`/v2/Catalog/Variant/Option/{id}`
PUT	`/v2/Catalog/Variant/Option/Reactivate/{id}`
DELETE	`/v2/Catalog/Variant/Option/{id}`

Product Kit

Method	Endpoint
GET	`/v2/Catalog/Kit/{id}`
POST	`/v2/Catalog/Kit`
PUT	`/v2/Catalog/Kit/{id}`
PUT	`/v2/Catalog/Kit/Reactivate/{id}`
DELETE	`/v2/Catalog/Kit/{id}`

Product Alternate Id

Method	Endpoint
GET	`/v2/Catalog/AlternateId/{id}`
GET	`/v2/Catalog/AlternateId/Find/{alternateId}`
POST	`/v2/Catalog/AlternateId`
PUT	`/v2/Catalog/AlternateId/{id}`
PUT	`/v2/Catalog/AlternateId/Reactivate/{id}`
DELETE	`/v2/Catalog/AlternateId/{id}`

Product Variant Alternate Id

Method	Endpoint
GET	`/v2/Catalog/Variant/AlternateId/{id}`
POST	`/v2/Catalog/Variant/AlternateId`
PUT	`/v2/Catalog/Variant/AlternateId/{id}`
PUT	`/v2/Catalog/Variant/AlternateId/Reactivate/{id}`
DELETE	`/v2/Catalog/Variant/AlternateId/{id}`

Product Variant Related

Method	Endpoint
GET	`/v2/Catalog/Variant/Related/{id}`
POST	`/v2/Catalog/Variant/Related`
PUT	`/v2/Catalog/Variant/Related/{id}`
PUT	`/v2/Catalog/Variant/Related/Reactivate/{id}`
DELETE	`/v2/Catalog/Variant/Related/{id}`

Related Product

Method	Endpoint
GET	`/v2/Catalog/Related/{id}`
POST	`/v2/Catalog/Related`
PUT	`/v2/Catalog/Related/{id}`
PUT	`/v2/Catalog/Related/Reactivate/{id}`
DELETE	`/v2/Catalog/Related/{id}`

Alternate Id Type

Method	Endpoint
GET	`/v2/Catalog/AlternateIdTypes`
GET	`/v2/Catalog/AlternateIdType/{id}`
POST	`/v2/Catalog/AlternateIdType`
PUT	`/v2/Catalog/AlternateIdType/{id}`
PUT	`/v2/Catalog/AlternateIdType/Reactivate/{id}`
DELETE	`/v2/Catalog/AlternateIdType/{id}`

Bulk Price

Method	Endpoint
GET	`/v2/Catalog/Price/Bulk/{id}`
GET	`/v2/Catalog/Price/Bulk`
POST	`/v2/Catalog/Price/Bulk`
PUT	`/v2/Catalog/Price/Bulk/{id}`
PUT	`/v2/Catalog/Price/Bulk/Reactivate/{id}`
DELETE	`/v2/Catalog/Price/Bulk/{id}`

Variant Unit

Method	Endpoint
POST	`/v2/Catalog/Variant/Unit`
PUT	`/v2/Catalog/Variant/Unit/Reactivate/{id}`
DELETE	`/v2/Catalog/Variant/Unit/{id}`

Product Custom Field

Method	Endpoint
POST	`/v2/CustomField/Catalog`
PUT	`/v2/CustomField/Catalog/{id}`
DELETE	`/v2/CustomField/Catalog/{id}/{type}`

Location

Method	Endpoint
GET	`/v2/Catalog/Locations`
GET	`/v2/Catalog/Location/{id}`
GET	`/v2/Catalog/LocationGroups`
GET	`/v2/Catalog/LocationGroup/{id}`
POST	`/v2/Catalog/Location`
POST	`/v2/Catalog/LocationGroup`
PUT	`/v2/Catalog/Location/{id}`
PUT	`/v2/Catalog/Location/Reactivate/{id}`
PUT	`/v2/Catalog/LocationGroup/{id}`
PUT	`/v2/Catalog/LocationGroup/Reactivate/{id}`
DELETE	`/v2/Catalog/Location/{id}`
DELETE	`/v2/Catalog/LocationGroup/{id}`

Location Address

Method	Endpoint
GET	`/v2/Catalog/Location/{location_id}/Address/{id}`
POST	`/v2/Catalog/Location/{location_id}/Address`
PUT	`/v2/Catalog/Location/{location_id}/Address/{id}`
PUT	`/v2/Catalog/Location/{location_id}/Address/Reactivate/{id}`
DELETE	`/v2/Catalog/Location/{location_id}/Address/{id}`

Location Relationship

Method	Endpoint
GET	`/v2/Catalog/Location/{location_id}/Relationship/{id}`
POST	`/v2/Catalog/Location/{location_id}/Relationship`
PUT	`/v2/Catalog/Location/{location_id}/Relationship/{id}`
PUT	`/v2/Catalog/Location/{location_id}/Relationship/Reactivate/{id}`
DELETE	`/v2/Catalog/Location/{location_id}/Relationship/{id}`

Customers

Customer

Method	Endpoint
GET	`/v2/Customers`
GET	`/v2/Customer/{id}`
POST	`/v2/Customer`
PUT	`/v2/Customer/{id}`
PUT	`/v2/Customer/Reactivate/{id}`
DELETE	`/v2/Customer/{id}`

Customer Address

Method	Endpoint
GET	`/v2/Customer/Address/{id}`
POST	`/v2/Customer/Address`
PUT	`/v2/Customer/Address/{id}`
PUT	`/v2/Customer/Address/Reactivate/{id}`
DELETE	`/v2/Customer/Address/{id}`

Customer Category

Method	Endpoint
GET	`/v2/Customer/Categories`
GET	`/v2/Customer/Category/{id}`
GET	`/v2/Customer/Category/Assignment/{id}`
POST	`/v2/Customer/Category`
POST	`/v2/Customer/Category/Assignment`
PUT	`/v2/Customer/Category/{id}`
PUT	`/v2/Customer/Category/Reactivate/{id}`
DELETE	`/v2/Customer/Category/{id}`
DELETE	`/v2/Customer/Category/Assignment/{id}`

Customer Company

Method	Endpoint
GET	`/v2/Customer/Companies`
GET	`/v2/Customer/Company/{id}`
POST	`/v2/Customer/Company`
PUT	`/v2/Customer/Company/{id}`
PUT	`/v2/Customer/Company/Reactivate/{id}`
DELETE	`/v2/Customer/Company/{id}`

Company Relationship

Method	Endpoint
GET	`/v2/Company/Relationship/{id}`
POST	`/v2/Company/Relationship`
PUT	`/v2/Company/Relationship/{id}`
PUT	`/v2/Company/Relationship/Reactivate/{id}`
DELETE	`/v2/Company/Relationship/{id}`

Customer Company Relationship

Method	Endpoint
GET	`/v2/Customer/Relationship/{id}`
POST	`/v2/Customer/Relationship`
PUT	`/v2/Customer/Relationship/{id}`
PUT	`/v2/Customer/Relationship/Reactivate/{id}`
DELETE	`/v2/Customer/Relationship/{id}`

Customer Custom Field

Method	Endpoint
POST	`/v2/CustomField/Customer`
PUT	`/v2/CustomField/Customer/{id}`
DELETE	`/v2/CustomField/Customer/{id}/{type}`

Transactions

Transaction

Method	Endpoint
GET	`/v2/Transaction/{id}`
GET	`/v2/Transactions`
POST	`/v2/Transaction`
PUT	`/v2/Transaction/{id}`
PUT	`/v2/Transaction/Reactivate/{id}`
DELETE	`/v2/Transaction/{id}`

Transaction Line

Method	Endpoint
GET	`/v2/Transaction/Line/{id}`
POST	`/v2/Transaction/Line`
PUT	`/v2/Transaction/Line/{id}`
PUT	`/v2/Transaction/Line/Reactivate/{id}`
DELETE	`/v2/Transaction/Line/{id}`

Transaction Note

Method	Endpoint
GET	`/v2/Transaction/Note/{id}`
POST	`/v2/Transaction/Note`
PUT	`/v2/Transaction/Note/{id}`
PUT	`/v2/Transaction/Note/Reactivate/{id}`
DELETE	`/v2/Transaction/Note/{id}`

Transaction Payment

Method	Endpoint
GET	`/v2/Transaction/Payment/{id}`
POST	`/v2/Transaction/Payment`
PUT	`/v2/Transaction/Payment/{id}`
PUT	`/v2/Transaction/Payment/Reactivate/{id}`
DELETE	`/v2/Transaction/Payment/{id}`

Transaction Shipping Address

Method	Endpoint
GET	`/v2/Transaction/Address/{id}`
POST	`/v2/Transaction/Address`
PUT	`/v2/Transaction/Address/{id}`
PUT	`/v2/Transaction/Address/Reactivate/{id}`
DELETE	`/v2/Transaction/Address/{id}`

Transaction Tax

Method	Endpoint
GET	`/v2/Transaction/Tax/{id}`
POST	`/v2/Transaction/Tax`
PUT	`/v2/Transaction/Tax/{id}`
PUT	`/v2/Transaction/Tax/Reactivate/{id}`
DELETE	`/v2/Transaction/Tax/{id}`

Transaction Tracking

Method	Endpoint
GET	`/v2/Transaction/Tracking/{id}`
POST	`/v2/Transaction/Tracking`
PUT	`/v2/Transaction/Tracking/{id}`
PUT	`/v2/Transaction/Tracking/Reactivate/{id}`
DELETE	`/v2/Transaction/Tracking/{id}`

Transaction Custom Field

Method	Endpoint
POST	`/v2/CustomField/Transaction`
PUT	`/v2/CustomField/Transaction/{id}`
DELETE	`/v2/CustomField/Transaction/{id}/{type}`

Payment Method

Method	Endpoint
GET	`/v2/PaymentMethods`
GET	`/v2/PaymentMethod/{id}`
POST	`/v2/PaymentMethod`
PUT	`/v2/PaymentMethod/{id}`
PUT	`/v2/PaymentMethod/Reactivate/{id}`
DELETE	`/v2/PaymentMethod/{id}`

Shipping Method

Method	Endpoint
GET	`/v2/ShippingMethods`
GET	`/v2/ShippingMethod/{id}`
POST	`/v2/ShippingMethod`
PUT	`/v2/ShippingMethod/{id}`
PUT	`/v2/ShippingMethod/Reactivate/{id}`
DELETE	`/v2/ShippingMethod/{id}`

Employees

Employee

Method	Endpoint
GET	`/v1/Employees`
GET	`/v1/Employee/{id}`
POST	`/v1/Employee`
PUT	`/v1/Employee/{id}`
PUT	`/v1/Employee/Reactivate/{id}`
DELETE	`/v1/Employee/{id}`

Employee Address

Method	Endpoint
GET	`/v1/Employee/Address/{id}`
POST	`/v1/Employee/Address`
PUT	`/v1/Employee/Address/{id}`
PUT	`/v1/Employee/Address/Reactivate/{id}`
DELETE	`/v1/Employee/Address/{id}`

Timesheet

Method	Endpoint
GET	`/v1/Timesheets`
GET	`/v1/Timesheet/{id}`
POST	`/v1/Timesheet`
PUT	`/v1/Timesheet/{id}`
PUT	`/v1/Timesheet/Reactivate/{id}`
DELETE	`/v1/Timesheet/{id}`

Timesheet Entry

Method	Endpoint
GET	`/v1/Timesheet/Entry/{id}`
POST	`/v1/Timesheet/Entry`
PUT	`/v1/Timesheet/Entry/{id}`
PUT	`/v1/Timesheet/Entry/Reactivate/{id}`
DELETE	`/v1/Timesheet/Entry/{id}`

Employee Custom Field

Method	Endpoint
POST	`/v1/CustomField/Employee`
PUT	`/v1/CustomField/Employee/{id}`
DELETE	`/v1/CustomField/Employee/{id}/{type}`

Gift Cards

Gift Card

Method	Endpoint
GET	`/v2/GiftCards`
GET	`/v2/GiftCard/{id}`
GET	`/v2/GiftCard/Activity/{id}`
GET	`/v2/GiftCard/Activities/{id}`
POST	`/v2/GiftCard`
PUT	`/v1/CompanyPlanSubscribedEnhancement/Reactivate/{id}`
PUT	`/v1/CompanyPlanUserAcceptance/Reactivate/{id}`
PUT	`/v2/GiftCard/{id}`
PUT	`/v2/GiftCard/Reactivate/{id}`
DELETE	`/v2/GiftCard/{id}`

Gift Card Custom Field

Method	Endpoint
POST	`/v2/CustomField/GiftCard`
PUT	`/v2/CustomField/GiftCard/{id}`
DELETE	`/v2/CustomField/GiftCard/{id}/{type}`

Media

Image

Method	Endpoint
GET	`/v2/Image/{id}`
GET	`/v2/Images`
POST	`/v2/Image`
PUT	`/v2/Image/{id}`
PUT	`/v2/Image/Reactivate/{id}`
DELETE	`/v2/Image/{id}`

Message

Method	Endpoint
GET	`/v2/Message/{id}`
GET	`/v2/Messages`
POST	`/v2/Message`
PUT	`/v2/Message/{id}`
DELETE	`/v2/Message/{id}`

Message Custom Field

Method	Endpoint
POST	`/v2/CustomField/Message`
PUT	`/v2/CustomField/Message/{id}`
DELETE	`/v2/CustomField/Message/{id}/{type}`

External Id

Applies across record types.

External Id

Method	Endpoint
GET	`/v1/External/LookupExternal/{id}/{systemId}/{tablename}`
GET	`/v1/External/LookupSpaceport/{systemId}/{tablename}/{*externalid}`
GET	`/v2/External/LookupExternal/{id}/{systemId}/{tablename}`
GET	`/v2/External/LookupSpaceport/{systemId}/{tablename}/{*externalid}`
GET	`/v2/External/Missing/{systemId}/{tableName}`
GET	`/v2/External/LookupExternal/{id}/{systemId}/{tableName}`
GET	`/v2/External/LookupSpaceport/{systemId}/{tableName}/{*externalid}`
POST	`/v1/External/LookupSpecial`
POST	`/v1/External/UpdateExternalId`
POST	`/v2/External/LookupSpecial`
POST	`/v2/External/UpdateExternalId`
DELETE	`/v1/External`
DELETE	`/v2/External`

Custom Field

Governs external custom fields (custom fields on integrated technology records). Custom fields defined within an iPaaS.com data type are governed by that type's own custom field permission, such as Product Custom Field or Customer Custom Field.

Custom Field

Method	Endpoint
GET	`/v2/CustomField/{id}`
GET	`/v2/CustomFields`
GET	`/v2/CustomField/Value/{collection_type}/{field_name}/{id}`
GET	`/v2/CustomField/Filtered/{collection_type}`
POST	`/v2/CustomField`
PUT	`/v2/CustomField/{id}`
PUT	`/v2/CustomField/Reactivate/{id}`
DELETE	`/v2/CustomField/{id}`

Subscription Settings

Complete Authorization

Method	Endpoint
GET	`/v2/Authorization/v2/Authorization/Initialize/{systemId}`
GET	`/v2/Shopify/AuthInitialize/{systemId}`
POST	`/v2/Authorization/AuthorizationComplete/{systemId}`
POST	`/v2/Authorization/AuthorizationComplete/Form/{systemId}`

Export Mapping

Method	Endpoint
GET	`/v2/Export/Mapping/{id}`
POST	`/v2/Export/Mapping`
PUT	`/v2/Export/Mapping/{id}`
DELETE	`/v2/Export/Mapping/{id}`

Export Mapping Collection

Method	Endpoint
GET	`/v2/Export/MappingCollection/{id}`
GET	`/v2/Export/MappingCollections`
GET	`/v2/Export/MappingCollection/GetChildren/{id}`
POST	`/v2/Export/MappingCollection/Sort`
POST	`/v2/Export/MappingCollection/{id}/Mapping/Sort`
POST	`/v2/Export/MappingCollection`
POST	`/v2/Export/MappingCollection/Trigger`
PUT	`/v2/Export/MappingCollection/{id}`
PUT	`/v2/Export/MappingCollection/Reactivate/{id}`
DELETE	`/v2/Export/MappingCollection/{id}`

Export Translation

Method	Endpoint
GET	`/v2/Export/Translation/{id}`
POST	`/v2/Export/Translation`
PUT	`/v2/Export/Translation/{id}`
PUT	`/v2/Export/Translation/Reactivate/{id}`
DELETE	`/v2/Export/Translation/{id}`

Export Translation Collection

Method	Endpoint
GET	`/v2/Export/TranslationCollections`
GET	`/v2/Export/TranslationCollection/{id}`
POST	`/v2/Export/TranslationCollection/Sort`
POST	`/v2/Export/TranslationCollection/{id}/Translation/Sort`
POST	`/v2/Export/TranslationCollection`
PUT	`/v2/Export/TranslationCollection/{id}`
PUT	`/v2/Export/TranslationCollection/Reactivate/{id}`
DELETE	`/v2/Export/TranslationCollection/{id}`

Mapping

Method	Endpoint
GET	`/v2/Mapping/{id}`
GET	`/v2/Mapping/InvalidMappings`
GET	`/v2/Mappings`
POST	`/v2/Mapping`
PUT	`/v2/Export/Mapping/Reactivate/{id}`
PUT	`/v2/Mapping/{id}`
PUT	`/v2/Mapping/Reactivate/{id}`
DELETE	`/v2/Mapping/{id}`

Mapping Collection

Method	Endpoint
GET	`/v2/MappingCollections`
GET	`/v2/MappingCollection/GetChildren/{id}`
GET	`/v2/MappingCollection/{id}`
GET	`/v2/MappingCollection/Parents/{id}`
POST	`/v2/MappingCollection/Sort`
POST	`/v2/MappingCollection/{id}/Mapping/Sort`
POST	`/v2/MappingCollection`
POST	`/v2/MappingCollection/ReverseClone`
PUT	`/v2/MappingCollection/{id}`
PUT	`/v2/MappingCollection/Reactivate/{id}`
DELETE	`/v2/MappingCollection/{id}`

Subscription

Method	Endpoint
GET	`/v2/Integration/{id}`
GET	`/v2/Integration/{integrationVersionId}/CustomField/{customFieldName}`
GET	`/v2/OAuth/{id}`
GET	`/v2/Subscription/{id}`
GET	`/v2/Subscriptions`
POST	`/v2/Subscription`
POST	`/v2/Subscription/PersistentData/{id}`
POST	`/v2/{id}/Initialize/{type}`
POST	`/v2/Subscription/Data/Initialize`
PUT	`/v2/Subscription/{id}`
PUT	`/v2/Subscription/Reactivate/{id}`
DELETE	`/v2/OAuth/{systemId}`
DELETE	`/v2/Subscription/{id}`
DELETE	`/v2/Subscription/PersistentData/{id}/{name}`

Translation

Method	Endpoint
POST	`/v2/Translation`
PUT	`/v2/Translation/{id}`
PUT	`/v2/Translation/Reactivate/{id}`
DELETE	`/v2/Translation/{id}`

Translation Collection

Method	Endpoint
GET	`/v2/TranslationCollection/{id}`
GET	`/v2/TranslationCollections`
POST	`/v2/TranslationCollection/Clone`
POST	`/v2/TranslationCollection/{id}/Translation/Sort`
POST	`/v2/Mapping/TranslationCollections`
POST	`/v2/TranslationCollection`
POST	`/v2/TranslationCollection/ReverseClone`
POST	`/v2/TranslationCollection/Sort`
PUT	`/v2/TranslationCollection/{id}`
PUT	`/v2/TranslationCollection/Reactivate/{id}`
DELETE	`/v2/TranslationCollection/{id}`

Webhook

Method	Endpoint
GET	`/v2/CompanySubscription/CompanyFeed`
GET	`/v2/Webhook/{id}`
GET	`/v2/Webhooks`
GET	`/v2/Webhook/External/{id}`
GET	`/v2/Webhooks/External`
POST	`/v2/CompanySubscription`
POST	`/v2/TopicSubscription`
POST	`/v2/Webhook`
POST	`/v2/Webhook/External`
DELETE	`/v2/CompanySubscription`
DELETE	`/v2/TopicSubscription/{topicName}`
DELETE	`/v2/Webhook/{id}`
DELETE	`/v2/Webhook/External/{id}`

Utilities

Activity Logger

Method	Endpoint
GET	`/v2/Details`
GET	`/v2/Header/{id}`
GET	`/v2/Headers`
GET	`/v2/TopicSubscription/LogFeed/{topicName}`
POST	`/v2/Detail`
POST	`/v2/Header`

Billing

Method	Endpoint
GET	`/v1/CreditCard/{id}`
GET	`/v1/CreditCards`
GET	`/v1/CreditCard/Authorization/{id}`
GET	`/v1/CreditCard/Authorizations`
GET	`/v1/PromoCode/Lookup/{promoCode}`
POST	`/v1/CreditCard`
POST	`/v1/CreditCard/CreateProfile/{id}`
PUT	`/v1/CreditCard/{id}`
PUT	`/v1/CreditCard/Reactivate/{id}`
DELETE	`/v1/CreditCard/{id}`

Company

Method	Endpoint
GET	`/v2/Company/{id}`
GET	`/v2/MISP/Account/{id}`
GET	`/v2/Company/MISP`
POST	`/v2/Company`
PUT	`/v2/Company/{id}`
PUT	`/v2/MISP/Account/{id}`

Company Plan

Method	Endpoint
GET	`/v1/CompanyPlans`
GET	`/v1/CompanyPlan/{id}`
GET	`/v1/CompanyPlanActivePromos`
GET	`/v1/CompanyPlanActivePromo/{id}`
GET	`/v1/CompanyPlanSubscribedEnhancements`
GET	`/v1/CompanyPlanSubscribedEnhancement/{id}`
GET	`/v1/CompanyPlanUserAcceptance`
GET	`/v1/CompanyPlanUserAcceptance/{id}`
POST	`/v1/CompanyPlan`
POST	`/v1/CompanyPlanActivePromo`
POST	`/v1/CompanyPlanSubscribedEnhancement`
POST	`/v1/CompanyPlanUserAcceptance`
POST	`/v2/Shopify/BillingApproval`
PUT	`/v1/CompanyPlan/{id}`
PUT	`/v1/CompanyPlanActivePromo/{id}`
PUT	`/v1/CompanyPlanActivePromo/Reactivate/{id}`
PUT	`/v1/CompanyPlanSubscribedEnhancement/Reactivate/{id}`
PUT	`/v1/CompanyPlanUserAcceptance/Reactivate/{id}`
DELETE	`/v1/CompanyPlanActivePromo/{id}`
DELETE	`/v1/CompanyPlanSubscribedEnhancement/{id}`
DELETE	`/v1/CompanyPlanUserAcceptance/{id}`
DELETE	`/v2/Shopify/User/Reject`

Dashboard

Method	Endpoint
GET	`/v2/Watchdog/HealthCheck`

Debug Tracing

Method	Endpoint
POST	`/v2/Debug`

Email

Method	Endpoint
GET	`/v2/EmailTemplate/{id}`
GET	`/v2/EmailTemplates`
POST	`/v2/EmailTemplate`
POST	`/v2/CloneEmailTemplate`
PUT	`/v2/EmailTemplate/{id}`
PUT	`/v2/EmailTemplate/Reactivate/{id}`
DELETE	`/v2/EmailTemplate/{id}`

Error

Method	Endpoint
GET	`/v2/Error/{id}`
GET	`/v2/Errors`
POST	`/v2/Error`
POST	`/v2/Errors`
PUT	`/v2/Error/{id}`
DELETE	`/v2/Error/{id}`

Event

Method	Endpoint
GET	`/v2/Event/{id}`
GET	`/v2/Events`
POST	`/v2/Event`
PUT	`/v2/Event/{id}`
PUT	`/v2/Event/Reactivate/{id}`
DELETE	`/v2/Event/{id}`

Event Rules

Method	Endpoint
GET	`/v2/Event/Rule/{id}`
GET	`/v2/Event/Rules`
POST	`/v2/Event/Rule`
PUT	`/v2/Event/Rule/Reactivate/{id}`
DELETE	`/v2/Event/Rule/{id}`

Invoice

Method	Endpoint
GET	`/v1/Invoice/{id}`
GET	`/v1/Invoices`

Log

Method	Endpoint
GET	`/v2/Logs`
GET	`/v2/Log/{id}`
POST	`/v2/Log`

Lookup

Method	Endpoint
GET	`/v2/Lookup/Integration/{id}/Versions`
GET	`/v2/Lookup/CustomField`
GET	`/v2/Lookup/DynamicFormulas`
GET	`/v2/Lookup/Field`
GET	`/v2/Lookup/{name}`
GET	`/v2/Lookup/MappingCollections`
GET	`/v2/Lookup/Presets`
GET	`/v2/Lookup/Tables`
GET	`/v2/Scopes`
GET	`/v2/Scope/{id}`

Manage API Keys

Method	Endpoint
GET	`/v2/Auth/Tokens`
POST	`/v2/Auth/Token`
DELETE	`/v2/Auth/Token/{id}`

Permission

Method	Endpoint
GET	`/v2/Auth/Permissions`

Reporting

Method	Endpoint
GET	`/v2/Hook/Recent`
GET	`/v2/Hook/Active`
GET	`/v2/Aggregation`
GET	`/v2/DurationDetail/{id}`
GET	`/v2/Summary/{id}`

Role

Method	Endpoint
GET	`/v2/Roles`
GET	`/v2/Role/{id}`
GET	`/v2/Role/Users/{id}`
POST	`/v2/Role`
PUT	`/v2/Role/Permission/{id}`
PUT	`/v2/Role/{id}`
PUT	`/v2/Role/User/{id}`
PUT	`/v2/Role/Reactivate/{id}`
DELETE	`/v2/Role/{id}`

User

Method	Endpoint
GET	`/v2/User/ChangeCompany/{id}`
GET	`/v2/Users`
GET	`/v2/User/{id}`
GET	`/v2/User/{id}/Companies`
POST	`/v2/User`
PUT	`/v2/User/AccountReset/{id}`
PUT	`/v2/User/{id}`
DELETE	`/v2/User/{id}`

Integrator

These permissions apply to the integrator experience - building and maintaining integrations themselves.

Integration

Method	Endpoint
GET	`/v1/Integration/{id}`
GET	`/v1/Integrations`
GET	`/v1/OAuth/{id}`
PUT	`/v1/Integration/{id}`
DELETE	`/v1/OAuth/{id}`

Integration Approval

Method	Endpoint
POST	`/v1/Integration/Approval`
POST	`/v1/Template/Approval`

Integration Category

Method	Endpoint
POST	`/v1/Integration/Category/Assignment`
DELETE	`/v1/Integration/Category/Assignment/{id}`

Integration Feature Support

Method	Endpoint
POST	`/v1/Integration/FeatureSupport`
PUT	`/v1/Integration/FeatureSupport/{id}`
DELETE	`/v1/Integration/FeatureSupport/{id}`

Integration Field

Method	Endpoint
GET	`/v1/Integration/Fields`
GET	`/v1/Integration/Field/{id}`
POST	`/v1/Integration/Field`
PUT	`/v1/Integration/Field/{id}`
DELETE	`/v1/Integration/Field/{id}`

Integration Marketing Info

Method	Endpoint
POST	`/v1/Integration/Marketing`
PUT	`/v1/Integration/Marketing/{id}`
DELETE	`/v1/Integration/Marketing/{id}`

Integration Preset

Method	Endpoint
GET	`/v1/Integration/Presets`
GET	`/v1/Integration/Preset/{id}`
POST	`/v1/Integration/Preset`
PUT	`/v1/Integration/Preset/{id}`
DELETE	`/v1/Integration/Preset/{id}`

Integration Register

Method	Endpoint
POST	`/v1/Integration/Register`

Integration Scope

Method	Endpoint
GET	`/v1/Integration/Scopes`
GET	`/v1/Integration/Scope/{id}`
POST	`/v1/Integration/Scope`
PUT	`/v1/Integration/Scope/{id}`
DELETE	`/v1/Integration/Scope/{id}`

Integration Table

Method	Endpoint
GET	`/v1/Integration/FieldValue/{id}`
GET	`/v1/Integration/Table/{id}`
GET	`/v1/Integration/Tables`
POST	`/v1/Integration/FieldValue`
POST	`/v1/Integration/Table`
PUT	`/v1/Integration/FieldValue/{id}`
PUT	`/v1/Integration/Table/{id}`
DELETE	`/v1/Integration/FieldValue/{id}`
DELETE	`/v1/Integration/Table/{id}`

Integration Version

Method	Endpoint
POST	`/v1/Integration/FileUpload/{id}`
POST	`/v1/Integration/Deprecate/Version`
PUT	`/v1/Integration/Version/{id}`
PUT	`/v1/Integration/Version/Reactivate/{id}`
DELETE	`/v1/Integration/Version/{id}`

Integrator Dynamic Formula

Method	Endpoint
GET	`/v1/DynamicFormula/{id}`
GET	`/v1/DynamicFormulas`
POST	`/v1/DynamicFormula`
PUT	`/v1/DynamicFormula/{id}`
DELETE	`/v1/DynamicFormula/{id}`

Integrator User

Method	Endpoint
GET	`/v2/Webhook/Configuration/{id}`
POST	`/v1/Integration/Create/Template`
POST	`/v1/Integration/FileUpload/{id}`
POST	`/v2/Webhook/Configuration`
PUT	`/v2/Webhook/Configuration/{id}`
DELETE	`/v2/Webhook/Configuration/{id}`

Template Custom Field

Method	Endpoint
GET	`/v1/Template/CustomField/{id}`
GET	`/v1/Template/CustomFields`
POST	`/v1/Template/CustomField`
PUT	`/v1/Template/CustomField/{id}`
PUT	`/v1/Template/CustomField/Reactivate/{id}`
DELETE	`/v1/Template/CustomField/{id}`

Template Mapping

Method	Endpoint
GET	`/v1/Template/Mapping/{id}`
POST	`/v1/Template/Mapping`
PUT	`/v1/Template/Mapping/{id}`
PUT	`/v1/Template/Mapping/Reactivate/{id}`
DELETE	`/v1/Template/Mapping/{id}`

Template Mapping Collection

Method	Endpoint
GET	`/v1/Template/MappingCollections`
GET	`/v1/Template/MappingCollection/{id}`
POST	`/v1/Template/MappingCollection`
PUT	`/v1/Template/MappingCollection/{id}`
PUT	`/v1/Template/MappingCollection/Reactivate/{id}`
DELETE	`/v1/Template/MappingCollection/{id}`

Template Translation

Method	Endpoint
POST	`/v1/Template/Translation`
PUT	`/v1/Template/Translation/{id}`
PUT	`/v1/Template/Translation/Reactivate/{id}`
DELETE	`/v1/Template/Translation/{id}`

Template Translation Collection

Method	Endpoint
GET	`/v1/Template/TranslationCollection/{id}`
GET	`/v1/Template/TranslationCollections`
POST	`/v1/Template/TranslationCollection`
PUT	`/v1/Template/TranslationCollection/{id}`
PUT	`/v1/Template/TranslationCollection/Reactivate/{id}`
DELETE	`/v1/Template/TranslationCollection/{id}`

MiSP Administration

These permissions apply to Managed Integration Service Providers managing the subscribers they support.

Administer Customers

Method	Endpoint
GET	`/v2/MISP/Subscribers`

Administer MISP

Method	Endpoint
GET	`/v2/SharedRole/SharedRoleRequests`
GET	`/v2/SharedRole/PartnerSharedRoles`
GET	`/v2/SharedRole/{id}`
GET	`/v2/MISPs`
GET	`/v2/MISP/Requests`
GET	`/v2/Company/MISP`
GET	`/v2/Partner/Requests`
GET	`/v2/Partner/Request/{id}`
POST	`/v2/SharedRole/RequestRoleShare`
POST	`/v2/MISP/Request`
POST	`/v2/Partner/Request`
PUT	`/v2/SharedRole/ProcessSharedRoleRequest/{id}`
PUT	`/v2/MISP/ProcessRequest/{id}`
DELETE	`/v2/SharedRole/{id}`
DELETE	`/v2/MISP/{id}`

Available to All Users

These endpoints are not governed by any permission. They are reachable by any user (and, where noted, without authentication), so they do not need to be granted on a role.

Method	Endpoint
GET	`/v1/Health`
GET	`/v1/Hello`
GET	`/v2/Health`
GET	`/v2/Hello`
GET	`/v2/Service/Login/{username}/{password}`
GET	`/v2/Settings/Themes`
GET	`/v2/Settings/UserTheme`
GET	`/v2/Authorization/AuthorizationComplete`
GET	`/v2/Authorization/v2/Authorization/Initialize/{systemId}`
GET	`/v2/Registers`
GET	`/v2/Register/{id}`
GET	`/v2/Settings/Navigations`
POST	`/v2/Auth/Login`
POST	`/v2/Shopify/User/Register`
POST	`/v2/User/Register`
POST	`/v2/User/ResetPassword`
POST	`/v2/User/SendResetEmail/{email}`
POST	`/v2/Settings/UserTheme`
POST	`/v2/Authorization/Callback`
POST	`/v2/Authorization/Callback/{systemTypeVersionId}`
POST	`/v2/Authorization/AuthorizationComplete`
POST	`/v2/Event`
POST	`/v2/Register`
POST	`/v2/Auth/Refresh`
DELETE	`/v2/Register/{id}`
POST	`/v2/dynamic/{systemTypeName}`
POST	`/v2/dynamic/{systemTypeName}/{additionalSegment}`
POST	`/v2/dynamic/{systemTypeName}/{additionalSegment}/{additionalSegment2}`
POST	`/v2/dynamicForm/{systemTypeName}`
POST	`/v2/dynamicForm/{systemTypeName}/{additionalSegment}`
POST	`/v2/dynamicForm/{systemTypeName}/{additionalSegment}/{additionalSegment2}`
POST	`/v2/privacy/{systemTypeName}`
POST	`/v2/Shopify/OAuthExpress`
PUT	`/v2/dynamic/{systemTypeName}`
PUT	`/v2/dynamic/{systemTypeName}/{additionalSegment}`
PUT	`/v2/dynamic/{systemTypeName}/{additionalSegment}/{additionalSegment2}`

Appendix: Platform Permissions

These permissions exist in the platform but are not part of the standard subscriber role editor covered in the Permissions Reference. Listed here for completeness.

Generic

Method	Endpoint
POST	`/v2/{name}`

Global User

Method	Endpoint
POST	`/v1/Invoice/Line`
POST	`/v1/Invoice/Payment`

iPaaS.com Permissions Reference: Endpoints by Permission

Data Types

Products

Product

Product Variant

Product Category

Product Option

Product Unit

Product Inventory

Product Variant Inventory

Product Variant Option

Product Kit

Product Alternate Id

Product Variant Alternate Id

Product Variant Related

Related Product

Alternate Id Type

Bulk Price

Variant Unit

Product Custom Field

Location

Location Address

Location Relationship

Customers

Customer

Customer Address

Customer Category

Customer Company

Company Relationship

Customer Company Relationship

Customer Custom Field

Transactions

Transaction

Transaction Line

Transaction Note

Transaction Payment

Transaction Shipping Address

Transaction Tax

Transaction Tracking

Transaction Custom Field

Payment Method

Shipping Method

Employees

Employee

Employee Address

Timesheet

Timesheet Entry

Employee Custom Field

Gift Cards

Gift Card

Gift Card Custom Field

Media

Image

Message

Message Custom Field

External Id

External Id

Custom Field

Custom Field

Subscription Settings

Complete Authorization

Export Mapping

Export Mapping Collection

Export Translation

Export Translation Collection

Mapping

Mapping Collection

Subscription

Translation

Translation Collection

Webhook

Utilities

Activity Logger

Billing

Company

Company Plan

Dashboard

Debug Tracing

Email

Error