API Categories

OpenAPI Explorer

Auto-generated OpenAPI definition for all enabled modules.

Default server: https://om.3.74.75.141.nip.io/api

Admin Dashboards

Showing 10 of 10 endpoints

GET/dashboards/layout

Auth requireddashboards.view

GET /dashboards/layout

Requires features: dashboards.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/layout" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/layout

Auth requireddashboards.configure

PUT /dashboards/layout

Requires features: dashboards.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/layout" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/dashboards/layout/{itemId}

Auth requireddashboards.configure

PATCH /dashboards/layout/{itemId}

Requires features: dashboards.configure

Parameters

Name	In	Required	Schema	Description
itemId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/dashboards/layout/:itemId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dashboards/roles/widgets

Auth requireddashboards.admin.assign-widgets

GET /dashboards/roles/widgets

Requires features: dashboards.admin.assign-widgets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/roles/widgets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/roles/widgets

Auth requireddashboards.admin.assign-widgets

PUT /dashboards/roles/widgets

Requires features: dashboards.admin.assign-widgets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/roles/widgets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dashboards/users/widgets

Auth requireddashboards.admin.assign-widgets

GET /dashboards/users/widgets

Requires features: dashboards.admin.assign-widgets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/users/widgets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/users/widgets

Auth requireddashboards.admin.assign-widgets

PUT /dashboards/users/widgets

Requires features: dashboards.admin.assign-widgets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/users/widgets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dashboards/widgets/catalog

Auth requireddashboards.admin.assign-widgets

GET /dashboards/widgets/catalog

Requires features: dashboards.admin.assign-widgets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/widgets/catalog" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dashboards/widgets/data

Auth requiredanalytics.view

POST /dashboards/widgets/data

Requires features: analytics.view

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dashboards/widgets/data" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dashboards/widgets/data/batch

Auth requiredanalytics.view

POST /dashboards/widgets/data/batch

Requires features: analytics.view

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dashboards/widgets/data/batch" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Authentication & Accounts

Showing 20 of 35 endpoints

GET/auth/admin/nav

Auth required

GET /auth/admin/nav

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/admin/nav" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/auth/feature-check

Auth required

POST /auth/feature-check

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/feature-check" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/features

Auth requiredauth.acl.manage

GET /auth/features

Requires features: auth.acl.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/features" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/locale

GET /auth/locale

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/locale" \
  -H "Accept: application/json"

POST/auth/locale

POST /auth/locale

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/locale" \
  -H "Accept: application/json"

POST/auth/logout

Auth required

POST /auth/logout

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/logout" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/profile

Auth required

GET /auth/profile

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/profile" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/auth/profile

Auth required

PUT /auth/profile

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/profile" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/auth/reset

POST /auth/reset

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/reset" \
  -H "Accept: application/json"

POST/auth/reset/confirm

POST /auth/reset/confirm

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/reset/confirm" \
  -H "Accept: application/json"

GET/auth/roles

Auth requiredauth.roles.list

GET /auth/roles

Requires features: auth.roles.list

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/auth/roles

Auth requiredauth.roles.manage

POST /auth/roles

Requires features: auth.roles.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/auth/roles

Auth requiredauth.roles.manage

PUT /auth/roles

Requires features: auth.roles.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/auth/roles

Auth requiredauth.roles.manage

DELETE /auth/roles

Requires features: auth.roles.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/roles/acl

Auth requiredauth.acl.manage

GET /auth/roles/acl

Requires features: auth.acl.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/roles/acl" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/auth/roles/acl

Auth requiredauth.acl.manage

PUT /auth/roles/acl

Requires features: auth.acl.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/roles/acl" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/session/refresh

GET /auth/session/refresh

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/auth/session/refresh" \
  -H "Accept: application/json"

POST/auth/session/refresh

POST /auth/session/refresh

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/auth/session/refresh" \
  -H "Accept: application/json"

Directory (Tenants & Organizations)

Showing 13 of 13 endpoints

GET/directory/organization-branding

Auth requireddirectory.organizations.view

GET /directory/organization-branding

Requires features: directory.organizations.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organization-branding" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/directory/organization-branding

Auth requireddirectory.organizations.manage

PUT /directory/organization-branding

Requires features: directory.organizations.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/organization-branding" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/directory/organization-switcher

Auth required

GET /directory/organization-switcher

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organization-switcher" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/directory/organizations

Auth requireddirectory.organizations.view

GET /directory/organizations

Requires features: directory.organizations.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organizations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/directory/organizations

Auth requireddirectory.organizations.manage

POST /directory/organizations

Requires features: directory.organizations.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/directory/organizations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/directory/organizations

Auth requireddirectory.organizations.manage

PUT /directory/organizations

Requires features: directory.organizations.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/organizations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/directory/organizations

Auth requireddirectory.organizations.manage

DELETE /directory/organizations

Requires features: directory.organizations.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/directory/organizations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/directory/organizations/lookup

GET /directory/organizations/lookup

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organizations/lookup" \
  -H "Accept: application/json"

GET/directory/tenants

Auth requireddirectory.tenants.view

GET /directory/tenants

Requires features: directory.tenants.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/tenants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/directory/tenants

Auth requireddirectory.tenants.manage

POST /directory/tenants

Requires features: directory.tenants.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/directory/tenants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/directory/tenants

Auth requireddirectory.tenants.manage

PUT /directory/tenants

Requires features: directory.tenants.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/tenants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/directory/tenants

Auth requireddirectory.tenants.manage

DELETE /directory/tenants

Requires features: directory.tenants.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/directory/tenants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/directory/tenants/lookup

GET /directory/tenants/lookup

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/directory/tenants/lookup" \
  -H "Accept: application/json"

Customer Relationship Management

Showing 20 of 102 endpoints

GET/customers/activities

Auth requiredcustomers.activities.view

GET /customers/activities

Requires features: customers.activities.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/activities

Auth requiredcustomers.activities.manage

POST /customers/activities

Requires features: customers.activities.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/customers/activities

Auth requiredcustomers.activities.manage

PUT /customers/activities

Requires features: customers.activities.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/customers/activities

Auth requiredcustomers.activities.manage

DELETE /customers/activities

Requires features: customers.activities.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/addresses

Auth requiredcustomers.activities.view

GET /customers/addresses

Requires features: customers.activities.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/addresses

Auth requiredcustomers.activities.manage

POST /customers/addresses

Requires features: customers.activities.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customers/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/customers/addresses

Auth requiredcustomers.activities.manage

PUT /customers/addresses

Requires features: customers.activities.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/customers/addresses

Auth requiredcustomers.activities.manage

DELETE /customers/addresses

Requires features: customers.activities.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/assignable-staff

Auth requiredcustomers.roles.view

GET /customers/assignable-staff

Requires features: customers.roles.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/assignable-staff" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/comments

Auth requiredcustomers.activities.view

GET /customers/comments

Requires features: customers.activities.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/comments

Auth requiredcustomers.activities.manage

POST /customers/comments

Requires features: customers.activities.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customers/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/customers/comments

Auth requiredcustomers.activities.manage

PUT /customers/comments

Requires features: customers.activities.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/customers/comments

Auth requiredcustomers.activities.manage

DELETE /customers/comments

Requires features: customers.activities.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies

Auth requiredcustomers.companies.view

GET /customers/companies

Requires features: customers.companies.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/companies

Auth requiredcustomers.companies.manage

POST /customers/companies

Requires features: customers.companies.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customers/companies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/customers/companies

Auth requiredcustomers.companies.manage

PUT /customers/companies

Requires features: customers.companies.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/companies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/customers/companies

Auth requiredcustomers.companies.manage

DELETE /customers/companies

Requires features: customers.companies.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/companies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies/{id}

Auth requiredcustomers.companies.view

GET /customers/companies/{id}

Requires features: customers.companies.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies/{id}/people

Auth requiredcustomers.companies.view

GET /customers/companies/{id}/people

Requires features: customers.companies.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id/people" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies/{id}/roles

Auth requiredcustomers.roles.view

GET /customers/companies/{id}/roles

Requires features: customers.roles.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Table perspectives

Showing 4 of 4 endpoints

GET/perspectives/{tableId}

Auth requiredperspectives.use

GET /perspectives/{tableId}

Requires features: perspectives.use

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/perspectives/:tableId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/perspectives/{tableId}

Auth requiredperspectives.use

POST /perspectives/{tableId}

Requires features: perspectives.use

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/perspectives/:tableId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/perspectives/{tableId}/{perspectiveId}

Auth requiredperspectives.use

DELETE /perspectives/{tableId}/{perspectiveId}

Requires features: perspectives.use

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—
perspectiveId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/perspectives/:tableId/:perspectiveId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/perspectives/{tableId}/roles/{roleId}

Auth requiredperspectives.role_defaults

DELETE /perspectives/{tableId}/roles/{roleId}

Requires features: perspectives.role_defaults

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—
roleId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/perspectives/:tableId/roles/:roleId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Custom Entities & Fields

Showing 17 of 17 endpoints

GET/entities/definitions

Auth required

GET /entities/definitions

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/definitions

Auth requiredentities.definitions.manage

POST /entities/definitions

Requires features: entities.definitions.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/entities/definitions

Auth requiredentities.definitions.manage

DELETE /entities/definitions

Requires features: entities.definitions.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/definitions.batch

Auth requiredentities.definitions.manage

POST /entities/definitions.batch

Requires features: entities.definitions.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions.batch" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/definitions.manage

Auth requiredentities.definitions.manage

GET /entities/definitions.manage

Requires features: entities.definitions.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/definitions.manage" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/definitions.restore

Auth requiredentities.definitions.manage

POST /entities/definitions.restore

Requires features: entities.definitions.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions.restore" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/encryption

Auth requiredentities.definitions.manage

GET /entities/encryption

Requires features: entities.definitions.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/encryption" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/encryption

Auth requiredentities.definitions.manage

POST /entities/encryption

Requires features: entities.definitions.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/encryption" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/entities

Auth required

GET /entities/entities

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/entities

Auth requiredentities.definitions.manage

POST /entities/entities

Requires features: entities.definitions.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/entities/entities

Auth requiredentities.definitions.manage

DELETE /entities/entities

Requires features: entities.definitions.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/records

Auth requiredentities.records.view

GET /entities/records

Requires features: entities.records.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/records

Auth requiredentities.records.manage

POST /entities/records

Requires features: entities.records.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/entities/records

Auth requiredentities.records.manage

PUT /entities/records

Requires features: entities.records.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/entities/records

Auth requiredentities.records.manage

DELETE /entities/records

Requires features: entities.records.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/relations/options

Auth requiredentities.definitions.view

GET /entities/relations/options

Requires features: entities.definitions.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/entities/relations/options" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Configuration

Showing 6 of 6 endpoints

GET/configs/cache

Auth requiredconfigs.cache.view

GET /configs/cache

Requires features: configs.cache.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/configs/cache" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/cache

Auth requiredconfigs.cache.manage

POST /configs/cache

Requires features: configs.cache.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/configs/cache" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/configs/system-status

Auth requiredconfigs.system_status.view

GET /configs/system-status

Requires features: configs.system_status.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/configs/system-status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/system-status

Auth requiredconfigs.manage

POST /configs/system-status

Requires features: configs.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/configs/system-status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/configs/upgrade-actions

Auth requiredconfigs.manage

GET /configs/upgrade-actions

Requires features: configs.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/configs/upgrade-actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/upgrade-actions

Auth requiredconfigs.manage

POST /configs/upgrade-actions

Requires features: configs.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/configs/upgrade-actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Query Indexes

Showing 3 of 3 endpoints

POST/query_index/purge

Auth requiredquery_index.purge

POST /query_index/purge

Requires features: query_index.purge

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/query_index/purge" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/query_index/reindex

Auth requiredquery_index.reindex

POST /query_index/reindex

Requires features: query_index.reindex

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/query_index/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/query_index/status

Auth requiredquery_index.status.view

GET /query_index/status

Requires features: query_index.status.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/query_index/status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Audit & Action Logs

Showing 5 of 5 endpoints

GET/audit_logs/audit-logs/access

Auth requiredaudit_logs.view_self

GET /audit_logs/audit-logs/access

Requires features: audit_logs.view_self

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/access" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/audit_logs/audit-logs/actions

Auth requiredaudit_logs.view_self

GET /audit_logs/audit-logs/actions

Requires features: audit_logs.view_self

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/audit_logs/audit-logs/actions/export

Auth requiredaudit_logs.view_self

GET /audit_logs/audit-logs/actions/export

Requires features: audit_logs.view_self

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/export" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/audit_logs/audit-logs/actions/redo

Auth requiredaudit_logs.redo_self

POST /audit_logs/audit-logs/actions/redo

Requires features: audit_logs.redo_self

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/redo" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/audit_logs/audit-logs/actions/undo

Auth requiredaudit_logs.undo_self

POST /audit_logs/audit-logs/actions/undo

Requires features: audit_logs.undo_self

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/undo" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Attachments

Showing 14 of 14 endpoints

GET/attachments

Auth requiredattachments.view

GET /attachments

Requires features: attachments.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments

Auth requiredattachments.manage

POST /attachments

Requires features: attachments.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/attachments

Auth requiredattachments.manage

DELETE /attachments

Requires features: attachments.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/file/{id}

GET /attachments/file/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/file/:id" \
  -H "Accept: application/json"

GET/attachments/image/{id}/{slug}

GET /attachments/image/{id}/{slug}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
slug	path	No	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/image/:id/:slug" \
  -H "Accept: application/json"

GET/attachments/library

Auth requiredattachments.view

GET /attachments/library

Requires features: attachments.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/library" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/library/{id}

Auth requiredattachments.view

GET /attachments/library/{id}

Requires features: attachments.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/attachments/library/{id}

Auth requiredattachments.manage

PATCH /attachments/library/{id}

Requires features: attachments.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/attachments/library/{id}

Auth requiredattachments.manage

DELETE /attachments/library/{id}

Requires features: attachments.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/partitions

Auth requiredattachments.manage

GET /attachments/partitions

Requires features: attachments.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments/partitions

Auth requiredattachments.manage

POST /attachments/partitions

Requires features: attachments.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/attachments/partitions

Auth requiredattachments.manage

PUT /attachments/partitions

Requires features: attachments.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/attachments/partitions

Auth requiredattachments.manage

DELETE /attachments/partitions

Requires features: attachments.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments/transfer

Auth requiredattachments.manage

POST /attachments/transfer

Requires features: attachments.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/attachments/transfer" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Product Catalog

Showing 20 of 36 endpoints

POST/catalog/bulk-delete

Auth requiredcatalog.products.manage

POST /catalog/bulk-delete

Requires features: catalog.products.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/bulk-delete" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/categories

Auth requiredcatalog.categories.view

GET /catalog/categories

Requires features: catalog.categories.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/categories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/categories

Auth requiredcatalog.categories.manage

POST /catalog/categories

Requires features: catalog.categories.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/categories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/catalog/categories

Auth requiredcatalog.categories.manage

PUT /catalog/categories

Requires features: catalog.categories.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/categories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/catalog/categories

Auth requiredcatalog.categories.manage

DELETE /catalog/categories

Requires features: catalog.categories.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/categories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/dictionaries/{key}

Auth requiredcatalog.products.manage

GET /catalog/dictionaries/{key}

Requires features: catalog.products.manage

Parameters

Name	In	Required	Schema	Description
key	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/dictionaries/:key" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/offers

Auth requiredsales.channels.manage

GET /catalog/offers

Requires features: sales.channels.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/offers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/offers

Auth requiredsales.channels.manage

POST /catalog/offers

Requires features: sales.channels.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/offers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/catalog/offers

Auth requiredsales.channels.manage

PUT /catalog/offers

Requires features: sales.channels.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/offers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/catalog/offers

Auth requiredsales.channels.manage

DELETE /catalog/offers

Requires features: sales.channels.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/offers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/option-schemas

Auth requiredcatalog.products.view

GET /catalog/option-schemas

Requires features: catalog.products.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/option-schemas

Auth requiredcatalog.settings.manage

POST /catalog/option-schemas

Requires features: catalog.settings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/catalog/option-schemas

Auth requiredcatalog.settings.manage

PUT /catalog/option-schemas

Requires features: catalog.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/catalog/option-schemas

Auth requiredcatalog.settings.manage

DELETE /catalog/option-schemas

Requires features: catalog.settings.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/price-kinds

Auth requiredcatalog.settings.manage

GET /catalog/price-kinds

Requires features: catalog.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/price-kinds

Auth requiredcatalog.settings.manage

POST /catalog/price-kinds

Requires features: catalog.settings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/catalog/price-kinds

Auth requiredcatalog.settings.manage

PUT /catalog/price-kinds

Requires features: catalog.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/catalog/price-kinds

Auth requiredcatalog.settings.manage

DELETE /catalog/price-kinds

Requires features: catalog.settings.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/prices

Auth requiredcatalog.products.view

GET /catalog/prices

Requires features: catalog.products.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/prices" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/prices

Auth requiredcatalog.pricing.manage

POST /catalog/prices

Requires features: catalog.pricing.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/prices" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Sales Management

Showing 20 of 108 endpoints

GET/sales/adjustment-kinds

Auth requiredsales.orders.view

GET /sales/adjustment-kinds

Requires features: sales.orders.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/adjustment-kinds

Auth requiredsales.settings.manage

POST /sales/adjustment-kinds

Requires features: sales.settings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/sales/adjustment-kinds

Auth requiredsales.settings.manage

PUT /sales/adjustment-kinds

Requires features: sales.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/sales/adjustment-kinds

Auth requiredsales.settings.manage

DELETE /sales/adjustment-kinds

Requires features: sales.settings.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sales/channels

Auth requiredsales.channels.manage

GET /sales/channels

Requires features: sales.channels.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/channels

Auth requiredsales.channels.manage

POST /sales/channels

Requires features: sales.channels.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sales/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/sales/channels

Auth requiredsales.channels.manage

PUT /sales/channels

Requires features: sales.channels.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/sales/channels

Auth requiredsales.channels.manage

DELETE /sales/channels

Requires features: sales.channels.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sales/credit-memos

Auth requiredsales.credit_memos.manage

GET /sales/credit-memos

Requires features: sales.credit_memos.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/credit-memos

Auth requiredsales.credit_memos.manage

POST /sales/credit-memos

Requires features: sales.credit_memos.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/sales/credit-memos

Auth requiredsales.credit_memos.manage

PUT /sales/credit-memos

Requires features: sales.credit_memos.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/sales/credit-memos

Auth requiredsales.credit_memos.manage

DELETE /sales/credit-memos

Requires features: sales.credit_memos.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sales/dashboard/widgets/new-orders

GET /sales/dashboard/widgets/new-orders

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/dashboard/widgets/new-orders" \
  -H "Accept: application/json"

GET/sales/dashboard/widgets/new-quotes

GET /sales/dashboard/widgets/new-quotes

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/dashboard/widgets/new-quotes" \
  -H "Accept: application/json"

GET/sales/delivery-windows

Auth requiredsales.settings.manage

GET /sales/delivery-windows

Requires features: sales.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/delivery-windows

Auth requiredsales.settings.manage

POST /sales/delivery-windows

Requires features: sales.settings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/sales/delivery-windows

Auth requiredsales.settings.manage

PUT /sales/delivery-windows

Requires features: sales.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/sales/delivery-windows

Auth requiredsales.settings.manage

DELETE /sales/delivery-windows

Requires features: sales.settings.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sales/document-addresses

Auth required

GET /sales/document-addresses

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/document-addresses

Auth required

POST /sales/document-addresses

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

API Keys

Showing 3 of 3 endpoints

GET/api_keys/keys

Auth requiredapi_keys.view

GET /api_keys/keys

Requires features: api_keys.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/api_keys/keys" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/api_keys/keys

Auth requiredapi_keys.create

POST /api_keys/keys

Requires features: api_keys.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/api_keys/keys" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/api_keys/keys

Auth requiredapi_keys.delete

DELETE /api_keys/keys

Requires features: api_keys.delete

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/api_keys/keys" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Shared Dictionaries

Showing 11 of 11 endpoints

GET/dictionaries

Auth requireddictionaries.view

GET /dictionaries

Requires features: dictionaries.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries

Auth requireddictionaries.manage

POST /dictionaries

Requires features: dictionaries.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dictionaries/{dictionaryId}

Auth requireddictionaries.view

GET /dictionaries/{dictionaryId}

Requires features: dictionaries.view

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/dictionaries/{dictionaryId}

Auth requireddictionaries.manage

PATCH /dictionaries/{dictionaryId}

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/dictionaries/{dictionaryId}

Auth requireddictionaries.manage

DELETE /dictionaries/{dictionaryId}

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dictionaries/{dictionaryId}/entries

Auth requireddictionaries.view

GET /dictionaries/{dictionaryId}/entries

Requires features: dictionaries.view

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries/{dictionaryId}/entries

Auth requireddictionaries.manage

POST /dictionaries/{dictionaryId}/entries

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/dictionaries/{dictionaryId}/entries/{entryId}

Auth requireddictionaries.manage

PATCH /dictionaries/{dictionaryId}/entries/{entryId}

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—
entryId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/:entryId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/dictionaries/{dictionaryId}/entries/{entryId}

Auth requireddictionaries.manage

DELETE /dictionaries/{dictionaryId}/entries/{entryId}

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—
entryId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/:entryId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries/{dictionaryId}/entries/reorder

Auth requireddictionaries.manage

POST /dictionaries/{dictionaryId}/entries/reorder

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/reorder" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries/{dictionaryId}/entries/set-default

Auth requireddictionaries.manage

POST /dictionaries/{dictionaryId}/entries/set-default

Requires features: dictionaries.manage

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/set-default" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Onboarding

Showing 4 of 4 endpoints

POST/onboarding/demo-feedback

POST /onboarding/demo-feedback

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/onboarding/demo-feedback" \
  -H "Accept: application/json"

POST/onboarding/onboarding

POST /onboarding/onboarding

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/onboarding/onboarding" \
  -H "Accept: application/json"

GET/onboarding/onboarding/status

GET /onboarding/onboarding/status

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/onboarding/onboarding/status" \
  -H "Accept: application/json"

GET/onboarding/onboarding/verify

GET /onboarding/onboarding/verify

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/onboarding/onboarding/verify" \
  -H "Accept: application/json"

API Documentation

Showing 1 of 1 endpoints

GET/version

GET /version

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/version" \
  -H "Accept: application/json"

Business Rules

Showing 17 of 17 endpoints

POST/business_rules/execute

Auth requiredbusiness_rules.execute

POST /business_rules/execute

Requires features: business_rules.execute

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/execute" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/execute/{ruleId}

Auth requiredbusiness_rules.execute

POST /business_rules/execute/{ruleId}

Requires features: business_rules.execute

Parameters

Name	In	Required	Schema	Description
ruleId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/execute/:ruleId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/logs

Auth requiredbusiness_rules.view_logs

GET /business_rules/logs

Requires features: business_rules.view_logs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/logs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/logs/{id}

Auth requiredbusiness_rules.view_logs

GET /business_rules/logs/{id}

Requires features: business_rules.view_logs

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/logs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/rules

Auth requiredbusiness_rules.view

GET /business_rules/rules

Requires features: business_rules.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/rules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/rules

Auth requiredbusiness_rules.manage

POST /business_rules/rules

Requires features: business_rules.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/rules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/business_rules/rules

Auth requiredbusiness_rules.manage

PUT /business_rules/rules

Requires features: business_rules.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/rules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/business_rules/rules

Auth requiredbusiness_rules.manage

DELETE /business_rules/rules

Requires features: business_rules.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/rules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/rules/{id}

Auth requiredbusiness_rules.view

GET /business_rules/rules/{id}

Requires features: business_rules.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/rules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/sets

Auth requiredbusiness_rules.view

GET /business_rules/sets

Requires features: business_rules.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/sets

Auth requiredbusiness_rules.manage_sets

POST /business_rules/sets

Requires features: business_rules.manage_sets

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/business_rules/sets

Auth requiredbusiness_rules.manage_sets

PUT /business_rules/sets

Requires features: business_rules.manage_sets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/business_rules/sets

Auth requiredbusiness_rules.manage_sets

DELETE /business_rules/sets

Requires features: business_rules.manage_sets

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/sets/{id}

Auth requiredbusiness_rules.view

GET /business_rules/sets/{id}

Requires features: business_rules.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/sets/{id}/members

Auth requiredbusiness_rules.manage_sets

POST /business_rules/sets/{id}/members

Requires features: business_rules.manage_sets

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/business_rules/sets/{id}/members

Auth requiredbusiness_rules.manage_sets

PUT /business_rules/sets/{id}/members

Requires features: business_rules.manage_sets

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/business_rules/sets/{id}/members

Auth requiredbusiness_rules.manage_sets

DELETE /business_rules/sets/{id}/members

Requires features: business_rules.manage_sets

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Feature Toggles

Showing 12 of 12 endpoints

GET/feature_toggles/check/boolean

Auth required

GET /feature_toggles/check/boolean

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/boolean" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/json

Auth required

GET /feature_toggles/check/json

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/json" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/number

Auth required

GET /feature_toggles/check/number

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/number" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/string

Auth required

GET /feature_toggles/check/string

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global

Auth requiredfeature_toggles.view

GET /feature_toggles/global

Requires features: feature_toggles.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/feature_toggles/global

Auth requiredfeature_toggles.global.manage

POST /feature_toggles/global

Requires features: feature_toggles.global.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/feature_toggles/global

Auth requiredfeature_toggles.global.manage

PUT /feature_toggles/global

Requires features: feature_toggles.global.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/feature_toggles/global

Auth requiredfeature_toggles.global.manage

DELETE /feature_toggles/global

Requires features: feature_toggles.global.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global/{id}

Auth requiredfeature_toggles.view

GET /feature_toggles/global/{id}

Requires features: feature_toggles.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global/{id}/override

Auth requiredfeature_toggles.view

GET /feature_toggles/global/{id}/override

Requires features: feature_toggles.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global/:id/override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/overrides

Auth requiredfeature_toggles.view

GET /feature_toggles/overrides

Requires features: feature_toggles.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/overrides" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/feature_toggles/overrides

Auth requiredfeature_toggles.manage

PUT /feature_toggles/overrides

Requires features: feature_toggles.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/feature_toggles/overrides" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Workflow Engine

Showing 20 of 23 endpoints

GET/workflows/definitions

GET /workflows/definitions

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/definitions" \
  -H "Accept: application/json"

POST/workflows/definitions

POST /workflows/definitions

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions" \
  -H "Accept: application/json"

GET/workflows/definitions/{id}

GET /workflows/definitions/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \
  -H "Accept: application/json"

PUT/workflows/definitions/{id}

PUT /workflows/definitions/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \
  -H "Accept: application/json"

DELETE/workflows/definitions/{id}

DELETE /workflows/definitions/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \
  -H "Accept: application/json"

POST/workflows/definitions/{id}/customize

POST /workflows/definitions/{id}/customize

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id/customize" \
  -H "Accept: application/json"

POST/workflows/definitions/{id}/reset-to-code

POST /workflows/definitions/{id}/reset-to-code

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id/reset-to-code" \
  -H "Accept: application/json"

GET/workflows/events

GET /workflows/events

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/events" \
  -H "Accept: application/json"

GET/workflows/events/{id}

GET /workflows/events/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/events/:id" \
  -H "Accept: application/json"

GET/workflows/instances

GET /workflows/instances

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances" \
  -H "Accept: application/json"

POST/workflows/instances

POST /workflows/instances

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances" \
  -H "Accept: application/json"

GET/workflows/instances/{id}

GET /workflows/instances/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances/:id" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/advance

POST /workflows/instances/{id}/advance

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/advance" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/cancel

POST /workflows/instances/{id}/cancel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/cancel" \
  -H "Accept: application/json"

GET/workflows/instances/{id}/events

GET /workflows/instances/{id}/events

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/events" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/retry

POST /workflows/instances/{id}/retry

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/retry" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/signal

POST /workflows/instances/{id}/signal

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/signal" \
  -H "Accept: application/json"

POST/workflows/instances/validate-start

POST /workflows/instances/validate-start

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/validate-start" \
  -H "Accept: application/json"

POST/workflows/signals

POST /workflows/signals

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/signals" \
  -H "Accept: application/json"

GET/workflows/tasks

GET /workflows/tasks

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/tasks" \
  -H "Accept: application/json"

Search

Showing 15 of 15 endpoints

GET/search/embeddings

Auth requiredsearch.embeddings.view

GET /search/embeddings

Requires features: search.embeddings.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/embeddings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/embeddings

Auth requiredsearch.embeddings.manage

POST /search/embeddings

Requires features: search.embeddings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/embeddings/reindex

Auth requiredsearch.embeddings.manage

POST /search/embeddings/reindex

Requires features: search.embeddings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/embeddings/reindex/cancel

Auth requiredsearch.embeddings.manage

POST /search/embeddings/reindex/cancel

Requires features: search.embeddings.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings/reindex/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/index

Auth requiredsearch.view

GET /search/index

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/index" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/search/index

Auth requiredsearch.embeddings.manage

DELETE /search/index

Requires features: search.embeddings.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/search/index" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/reindex

Auth requiredsearch.reindex

POST /search/reindex

Requires features: search.reindex

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/reindex/cancel

Auth requiredsearch.reindex

POST /search/reindex/cancel

Requires features: search.reindex

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/reindex/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/search

Auth requiredsearch.view

GET /search/search

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/search" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/search/global

Auth requiredsearch.view

GET /search/search/global

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/search/global" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings

Auth requiredsearch.view

GET /search/settings

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings/fulltext

Auth requiredsearch.view

GET /search/settings/fulltext

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/fulltext" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings/global-search

Auth requiredsearch.view

GET /search/settings/global-search

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/global-search" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/settings/global-search

Auth requiredsearch.manage

POST /search/settings/global-search

Requires features: search.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/search/settings/global-search" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings/vector-store

Auth requiredsearch.view

GET /search/settings/vector-store

Requires features: search.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/vector-store" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Currencies

Showing 14 of 14 endpoints

GET/currencies/currencies

Auth requiredcurrencies.view

GET /currencies/currencies

Requires features: currencies.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/currencies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/currencies

Auth requiredcurrencies.manage

POST /currencies/currencies

Requires features: currencies.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/currencies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/currencies/currencies

Auth requiredcurrencies.manage

PUT /currencies/currencies

Requires features: currencies.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/currencies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/currencies/currencies

Auth requiredcurrencies.manage

DELETE /currencies/currencies

Requires features: currencies.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/currencies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/currencies/currencies/options

Auth requiredcurrencies.view

GET /currencies/currencies/options

Requires features: currencies.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/currencies/options" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/currencies/exchange-rates

Auth requiredcurrencies.rates.view

GET /currencies/exchange-rates

Requires features: currencies.rates.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/exchange-rates

Auth requiredcurrencies.rates.manage

POST /currencies/exchange-rates

Requires features: currencies.rates.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/currencies/exchange-rates

Auth requiredcurrencies.rates.manage

PUT /currencies/exchange-rates

Requires features: currencies.rates.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/currencies/exchange-rates

Auth requiredcurrencies.rates.manage

DELETE /currencies/exchange-rates

Requires features: currencies.rates.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/currencies/fetch-configs

GET /currencies/fetch-configs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \
  -H "Accept: application/json"

POST/currencies/fetch-configs

POST /currencies/fetch-configs

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \
  -H "Accept: application/json"

PUT/currencies/fetch-configs

PUT /currencies/fetch-configs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \
  -H "Accept: application/json"

DELETE/currencies/fetch-configs

DELETE /currencies/fetch-configs

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \
  -H "Accept: application/json"

POST/currencies/fetch-rates

POST /currencies/fetch-rates

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/fetch-rates" \
  -H "Accept: application/json"

Worktime / Availabilities

Showing 10 of 10 endpoints

GET/planner/availability

Auth requiredplanner.view

GET /planner/availability

Requires features: planner.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/planner/availability" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability

Auth required

POST /planner/availability

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/planner/availability

Auth required

PUT /planner/availability

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/planner/availability" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/planner/availability

Auth required

DELETE /planner/availability

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/planner/availability" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability-date-specific

Auth required

POST /planner/availability-date-specific

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-date-specific" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/planner/availability-rule-sets

Auth requiredplanner.view

GET /planner/availability-rule-sets

Requires features: planner.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability-rule-sets

Auth requiredplanner.manage_availability

POST /planner/availability-rule-sets

Requires features: planner.manage_availability

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/planner/availability-rule-sets

Auth requiredplanner.manage_availability

PUT /planner/availability-rule-sets

Requires features: planner.manage_availability

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/planner/availability-rule-sets

Auth requiredplanner.manage_availability

DELETE /planner/availability-rule-sets

Requires features: planner.manage_availability

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability-weekly

Auth required

POST /planner/availability-weekly

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-weekly" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Resource planning

Showing 20 of 22 endpoints

GET/resources/activities

GET /resources/activities

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/resources/activities" \
  -H "Accept: application/json"

POST/resources/activities

POST /resources/activities

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/activities" \
  -H "Accept: application/json"

PUT/resources/activities

PUT /resources/activities

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/activities" \
  -H "Accept: application/json"

DELETE/resources/activities

DELETE /resources/activities

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/activities" \
  -H "Accept: application/json"

GET/resources/comments

Auth requiredresources.view

GET /resources/comments

Requires features: resources.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/resources/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/comments

Auth requiredresources.manage_resources

POST /resources/comments

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/resources/comments

Auth requiredresources.manage_resources

PUT /resources/comments

Requires features: resources.manage_resources

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/resources/comments

Auth requiredresources.manage_resources

DELETE /resources/comments

Requires features: resources.manage_resources

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/resources/resource-types

Auth requiredresources.view

GET /resources/resource-types

Requires features: resources.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/resources/resource-types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resource-types

Auth requiredresources.manage_resources

POST /resources/resource-types

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resource-types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/resources/resource-types

Auth requiredresources.manage_resources

PUT /resources/resource-types

Requires features: resources.manage_resources

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/resource-types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/resources/resource-types

Auth requiredresources.manage_resources

DELETE /resources/resource-types

Requires features: resources.manage_resources

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/resource-types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/resources/resources

Auth requiredresources.view

GET /resources/resources

Requires features: resources.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/resources/resources" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resources

Auth requiredresources.manage_resources

POST /resources/resources

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/resources/resources

Auth requiredresources.manage_resources

PUT /resources/resources

Requires features: resources.manage_resources

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/resources" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/resources/resources

Auth requiredresources.manage_resources

DELETE /resources/resources

Requires features: resources.manage_resources

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/resources" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resources/tags/assign

Auth requiredresources.manage_resources

POST /resources/resources/tags/assign

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources/tags/assign" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resources/tags/unassign

Auth requiredresources.manage_resources

POST /resources/resources/tags/unassign

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources/tags/unassign" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/resources/tags

Auth requiredresources.view

GET /resources/tags

Requires features: resources.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/resources/tags" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/tags

Auth requiredresources.manage_resources

POST /resources/tags

Requires features: resources.manage_resources

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/resources/tags" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Employees

Showing 20 of 58 endpoints

GET/staff/activities

GET /staff/activities

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/staff/activities" \
  -H "Accept: application/json"

POST/staff/activities

POST /staff/activities

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/staff/activities" \
  -H "Accept: application/json"

PUT/staff/activities

PUT /staff/activities

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/activities" \
  -H "Accept: application/json"

DELETE/staff/activities

DELETE /staff/activities

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/activities" \
  -H "Accept: application/json"

GET/staff/addresses

Auth requiredstaff.view

GET /staff/addresses

Requires features: staff.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/addresses

Auth requiredstaff.manage_team

POST /staff/addresses

Requires features: staff.manage_team

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/staff/addresses

Auth requiredstaff.manage_team

PUT /staff/addresses

Requires features: staff.manage_team

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/staff/addresses

Auth requiredstaff.manage_team

DELETE /staff/addresses

Requires features: staff.manage_team

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/staff/comments

Auth requiredstaff.view

GET /staff/comments

Requires features: staff.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/staff/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/comments

Auth requiredstaff.manage_team

POST /staff/comments

Requires features: staff.manage_team

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/staff/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/staff/comments

Auth requiredstaff.manage_team

PUT /staff/comments

Requires features: staff.manage_team

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/staff/comments

Auth requiredstaff.manage_team

DELETE /staff/comments

Requires features: staff.manage_team

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/staff/job-histories

Auth requiredstaff.view

GET /staff/job-histories

Requires features: staff.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/staff/job-histories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/job-histories

Auth requiredstaff.manage_team

POST /staff/job-histories

Requires features: staff.manage_team

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/staff/job-histories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/staff/job-histories

Auth requiredstaff.manage_team

PUT /staff/job-histories

Requires features: staff.manage_team

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/job-histories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/staff/job-histories

Auth requiredstaff.manage_team

DELETE /staff/job-histories

Requires features: staff.manage_team

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/job-histories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/staff/leave-requests

Auth required

GET /staff/leave-requests

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/leave-requests

Auth required

POST /staff/leave-requests

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/staff/leave-requests

Auth required

PUT /staff/leave-requests

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/staff/leave-requests

Auth required

DELETE /staff/leave-requests

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Events

Showing 2 of 2 endpoints

GET/events

Auth required

GET /events

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/events/stream

Auth required

GET /events/stream

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/events/stream" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Notifications

Showing 13 of 13 endpoints

GET/notifications

Auth required

GET /notifications

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/notifications" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications

Auth requirednotifications.create

POST /notifications

Requires features: notifications.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/{id}/action

Auth required

POST /notifications/{id}/action

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/:id/action" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/dismiss

Auth required

PUT /notifications/{id}/dismiss

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/dismiss" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/read

Auth required

PUT /notifications/{id}/read

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/restore

Auth required

PUT /notifications/{id}/restore

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/restore" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/batch

Auth requirednotifications.create

POST /notifications/batch

Requires features: notifications.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/batch" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/feature

Auth requirednotifications.create

POST /notifications/feature

Requires features: notifications.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/feature" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/mark-all-read

Auth required

PUT /notifications/mark-all-read

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/mark-all-read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/role

Auth requirednotifications.create

POST /notifications/role

Requires features: notifications.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/role" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/settings

Auth requirednotifications.manage

GET /notifications/settings

Requires features: notifications.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/notifications/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/settings

Auth requirednotifications.manage

POST /notifications/settings

Requires features: notifications.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/unread-count

Auth required

GET /notifications/unread-count

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/notifications/unread-count" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Progress

Showing 6 of 6 endpoints

GET/progress/active

Auth required

GET /progress/active

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/progress/active" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/progress/jobs

Auth required

GET /progress/jobs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/progress/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/progress/jobs

Auth requiredprogress.create

POST /progress/jobs

Requires features: progress.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/progress/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/progress/jobs/{id}

Auth required

GET /progress/jobs/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/progress/jobs/{id}

Auth requiredprogress.update

PUT /progress/jobs/{id}

Requires features: progress.update

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/progress/jobs/{id}

Auth requiredprogress.cancel

DELETE /progress/jobs/{id}

Requires features: progress.cancel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Integrations

Showing 8 of 8 endpoints

GET/integrations

Auth requiredintegrations.view

GET /integrations

Requires features: integrations.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/integrations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/{id}

Auth requiredintegrations.view

GET /integrations/{id}

Requires features: integrations.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/{id}/credentials

Auth requiredintegrations.credentials.manage

GET /integrations/{id}/credentials

Requires features: integrations.credentials.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/:id/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/credentials

Auth requiredintegrations.credentials.manage

PUT /integrations/{id}/credentials

Requires features: integrations.credentials.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/integrations/{id}/health

Auth requiredintegrations.manage

POST /integrations/{id}/health

Requires features: integrations.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/integrations/:id/health" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/state

Auth requiredintegrations.manage

PUT /integrations/{id}/state

Requires features: integrations.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/state" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/version

Auth requiredintegrations.manage

PUT /integrations/{id}/version

Requires features: integrations.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/version" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/logs

Auth requiredintegrations.manage

GET /integrations/logs

Requires features: integrations.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/logs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Data Sync

Showing 17 of 17 endpoints

GET/data_sync/mappings

Auth requireddata_sync.configure

GET /data_sync/mappings

Requires features: data_sync.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/mappings

Auth requireddata_sync.configure

POST /data_sync/mappings

Requires features: data_sync.configure

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/mappings/{id}

Auth requireddata_sync.configure

GET /data_sync/mappings/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/data_sync/mappings/{id}

Auth requireddata_sync.configure

PUT /data_sync/mappings/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/data_sync/mappings/{id}

Auth requireddata_sync.configure

DELETE /data_sync/mappings/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/options

Auth requireddata_sync.view

GET /data_sync/options

Requires features: data_sync.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/options" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/run

Auth requireddata_sync.run

POST /data_sync/run

Requires features: data_sync.run

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/run" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/runs

Auth requireddata_sync.view

GET /data_sync/runs

Requires features: data_sync.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/runs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/runs/{id}

Auth requireddata_sync.view

GET /data_sync/runs/{id}

Requires features: data_sync.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/runs/{id}/cancel

Auth requireddata_sync.run

POST /data_sync/runs/{id}/cancel

Requires features: data_sync.run

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/runs/{id}/retry

Auth requireddata_sync.run

POST /data_sync/runs/{id}/retry

Requires features: data_sync.run

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id/retry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/schedules

Auth requireddata_sync.configure

GET /data_sync/schedules

Requires features: data_sync.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/schedules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/schedules

Auth requireddata_sync.configure

POST /data_sync/schedules

Requires features: data_sync.configure

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/schedules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/schedules/{id}

Auth requireddata_sync.configure

GET /data_sync/schedules/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/data_sync/schedules/{id}

Auth requireddata_sync.configure

PUT /data_sync/schedules/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/data_sync/schedules/{id}

Auth requireddata_sync.configure

DELETE /data_sync/schedules/{id}

Requires features: data_sync.configure

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/validate

Auth requireddata_sync.configure

POST /data_sync/validate

Requires features: data_sync.configure

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/validate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Excel / CSV Import

Showing 3 of 3 endpoints

POST/sync_excel/import

Auth requiredsync_excel.run

POST /sync_excel/import

Requires features: sync_excel.run

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sync_excel/import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_excel/preview

Auth requiredsync_excel.view

GET /sync_excel/preview

Requires features: sync_excel.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sync_excel/preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_excel/upload

Auth requiredsync_excel.run

POST /sync_excel/upload

Requires features: sync_excel.run

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sync_excel/upload" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Messages

Showing 20 of 24 endpoints

GET/messages

Auth required

GET /messages

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/messages" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages

Auth requiredmessages.compose

POST /messages

Requires features: messages.compose

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/messages" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/messages/{id}

Auth required

GET /messages/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/messages/{id}

Auth requiredmessages.compose

PATCH /messages/{id}

Requires features: messages.compose

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}

Auth requiredmessages.view

DELETE /messages/{id}

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/actions/{actionId}

Auth requiredmessages.actions

POST /messages/{id}/actions/{actionId}

Requires features: messages.actions

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/actions/:actionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/archive

Auth requiredmessages.view

PUT /messages/{id}/archive

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/archive

Auth requiredmessages.view

DELETE /messages/{id}/archive

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/messages/{id}/attachments

Auth required

GET /messages/{id}/attachments

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/attachments

Auth requiredmessages.attach_files

POST /messages/{id}/attachments

Requires features: messages.attach_files

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/attachments

Auth requiredmessages.attach_files

DELETE /messages/{id}/attachments

Requires features: messages.attach_files

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/messages/{id}/confirmation

Auth required

GET /messages/{id}/confirmation

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/confirmation" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/conversation

Auth requiredmessages.view

DELETE /messages/{id}/conversation

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/conversation" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/conversation/archive

Auth requiredmessages.view

PUT /messages/{id}/conversation/archive

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/conversation/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/conversation/read

Auth requiredmessages.view

DELETE /messages/{id}/conversation/read

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/conversation/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/forward

Auth requiredmessages.compose

POST /messages/{id}/forward

Requires features: messages.compose

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/forward" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/messages/{id}/forward-preview

Auth requiredmessages.compose

GET /messages/{id}/forward-preview

Requires features: messages.compose

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/forward-preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/read

Auth requiredmessages.view

PUT /messages/{id}/read

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/read

Auth requiredmessages.view

DELETE /messages/{id}/read

Requires features: messages.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/reply

Auth requiredmessages.compose

POST /messages/{id}/reply

Requires features: messages.compose

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/reply" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Communication Channels

Showing 20 of 20 endpoints

GET/communication_channels/channels

Auth requiredcommunication_channels.view

GET /communication_channels/channels

Requires features: communication_channels.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/communication_channels/channels/{id}

Auth requiredcommunication_channels.connect_user_channel

DELETE /communication_channels/channels/{id}

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/channels/{id}

Auth requiredcommunication_channels.view

GET /communication_channels/channels/{id}

Requires features: communication_channels.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/channels/{id}/health

Auth requiredcommunication_channels.view

GET /communication_channels/channels/{id}/health

Requires features: communication_channels.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/health" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/import-history

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/{id}/import-history

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/import-history" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/poll-now

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/{id}/poll-now

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/poll-now" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/push/register

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/{id}/push/register

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/push/register" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/set-primary

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/{id}/set-primary

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/set-primary" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/test-send

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/{id}/test-send

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/test-send" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/connect/credentials

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/channels/connect/credentials

Requires features: communication_channels.connect_user_channel

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/connect/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/me/channels

Auth requiredcommunication_channels.connect_user_channel

GET /communication_channels/me/channels

Requires features: communication_channels.connect_user_channel

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/me/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/messages/{messageId}/reactions

Auth requiredcommunication_channels.react

POST /communication_channels/messages/{messageId}/reactions

Requires features: communication_channels.react

Parameters

Name	In	Required	Schema	Description
messageId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/messages/:messageId/reactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/communication_channels/messages/{messageId}/reactions/{reactionId}

Auth requiredcommunication_channels.react

DELETE /communication_channels/messages/{messageId}/reactions/{reactionId}

Requires features: communication_channels.react

Parameters

Name	In	Required	Schema	Description
messageId	path	Yes	any	—
reactionId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/communication_channels/messages/:messageId/reactions/:reactionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/oauth/{provider}/callback

Auth required

GET /communication_channels/oauth/{provider}/callback

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/oauth/:provider/callback" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/oauth/{provider}/initiate

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/oauth/{provider}/initiate

Requires features: communication_channels.connect_user_channel

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/oauth/:provider/initiate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/send-as-user

Auth requiredcommunication_channels.manage

POST /communication_channels/send-as-user

Requires features: communication_channels.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/send-as-user" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/test-seed

Auth requiredcommunication_channels.connect_user_channel

POST /communication_channels/test-seed

Requires features: communication_channels.connect_user_channel

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/test-seed" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/communication_channels/threads/{threadId}/assign

Auth requiredcommunication_channels.assign

PUT /communication_channels/threads/{threadId}/assign

Requires features: communication_channels.assign

Parameters

Name	In	Required	Schema	Description
threadId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/communication_channels/threads/:threadId/assign" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/webhook/{provider}

POST /communication_channels/webhook/{provider}

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/webhook/:provider" \
  -H "Accept: application/json"

POST/communication_channels/webhooks/gmail

POST /communication_channels/webhooks/gmail

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/webhooks/gmail" \
  -H "Accept: application/json"

AI Assistant

Showing 20 of 39 endpoints

GET/ai_assistant/ai/actions/{id}

Auth requiredai_assistant.view

GET /ai_assistant/ai/actions/{id}

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/actions/{id}/cancel

Auth requiredai_assistant.view

POST /ai_assistant/ai/actions/{id}/cancel

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/actions/{id}/confirm

Auth requiredai_assistant.view

POST /ai_assistant/ai/actions/{id}/confirm

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id/confirm" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents

Auth requiredai_assistant.view

GET /ai_assistant/ai/agents

Requires features: ai_assistant.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/loop-override

Auth requiredai_assistant.view

GET /ai_assistant/ai/agents/{agentId}/loop-override

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/ai_assistant/ai/agents/{agentId}/loop-override

Auth requiredai_assistant.settings.manage

PUT /ai_assistant/ai/agents/{agentId}/loop-override

Requires features: ai_assistant.settings.manage

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/ai_assistant/ai/agents/{agentId}/loop-override

Auth requiredai_assistant.settings.manage

DELETE /ai_assistant/ai/agents/{agentId}/loop-override

Requires features: ai_assistant.settings.manage

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/models

Auth requiredai_assistant.view

GET /ai_assistant/ai/agents/{agentId}/models

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/models" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth requiredai_assistant.view

GET /ai_assistant/ai/agents/{agentId}/mutation-policy

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth requiredai_assistant.settings.manage

POST /ai_assistant/ai/agents/{agentId}/mutation-policy

Requires features: ai_assistant.settings.manage

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth requiredai_assistant.settings.manage

DELETE /ai_assistant/ai/agents/{agentId}/mutation-policy

Requires features: ai_assistant.settings.manage

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/prompt-override

GET /ai_assistant/ai/agents/{agentId}/prompt-override

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/prompt-override" \
  -H "Accept: application/json"

POST/ai_assistant/ai/agents/{agentId}/prompt-override

POST /ai_assistant/ai/agents/{agentId}/prompt-override

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/prompt-override" \
  -H "Accept: application/json"

POST/ai_assistant/ai/chat

Auth requiredai_assistant.view

POST /ai_assistant/ai/chat

Requires features: ai_assistant.view

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/chat" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/conversations

Auth requiredai_assistant.view

GET /ai_assistant/ai/conversations

Requires features: ai_assistant.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/conversations

Auth requiredai_assistant.view

POST /ai_assistant/ai/conversations

Requires features: ai_assistant.view

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/conversations/{conversationId}

Auth requiredai_assistant.view

GET /ai_assistant/ai/conversations/{conversationId}

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/ai_assistant/ai/conversations/{conversationId}

Auth requiredai_assistant.view

PATCH /ai_assistant/ai/conversations/{conversationId}

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/ai_assistant/ai/conversations/{conversationId}

Auth requiredai_assistant.view

DELETE /ai_assistant/ai/conversations/{conversationId}

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/conversations/{conversationId}/participants

Auth requiredai_assistant.view

GET /ai_assistant/ai/conversations/{conversationId}/participants

Requires features: ai_assistant.view

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId/participants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Entity Translations

Showing 5 of 5 endpoints

GET/translations/{entityType}/{entityId}

Auth requiredtranslations.view

GET /translations/{entityType}/{entityId}

Requires features: translations.view

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/translations/{entityType}/{entityId}

Auth requiredtranslations.manage

PUT /translations/{entityType}/{entityId}

Requires features: translations.manage

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/translations/{entityType}/{entityId}

Auth requiredtranslations.manage

DELETE /translations/{entityType}/{entityId}

Requires features: translations.manage

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/translations/locales

GET /translations/locales

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/translations/locales" \
  -H "Accept: application/json"

PUT/translations/locales

PUT /translations/locales

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/translations/locales" \
  -H "Accept: application/json"

Scheduler

Showing 8 of 8 endpoints

GET/scheduler/jobs

Auth requiredscheduler.jobs.view

GET /scheduler/jobs

Requires features: scheduler.jobs.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/scheduler/jobs

Auth requiredscheduler.jobs.manage

POST /scheduler/jobs

Requires features: scheduler.jobs.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/scheduler/jobs

Auth requiredscheduler.jobs.manage

PUT /scheduler/jobs

Requires features: scheduler.jobs.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/scheduler/jobs

Auth requiredscheduler.jobs.manage

DELETE /scheduler/jobs

Requires features: scheduler.jobs.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/scheduler/jobs/{id}/executions

GET /scheduler/jobs/{id}/executions

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/jobs/:id/executions" \
  -H "Accept: application/json"

GET/scheduler/queue-jobs/{jobId}

GET /scheduler/queue-jobs/{jobId}

Parameters

Name	In	Required	Schema	Description
jobId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/queue-jobs/:jobId" \
  -H "Accept: application/json"

GET/scheduler/targets

GET /scheduler/targets

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/targets" \
  -H "Accept: application/json"

POST/scheduler/trigger

POST /scheduler/trigger

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/scheduler/trigger" \
  -H "Accept: application/json"

InboxOps — Email-to-ERP Agent

Showing 20 of 20 endpoints

GET/inbox_ops/emails

Auth requiredinbox_ops.log.view

GET /inbox_ops/emails

Requires features: inbox_ops.log.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/emails" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/emails/{id}

Auth requiredinbox_ops.log.view

GET /inbox_ops/emails/{id}

Requires features: inbox_ops.log.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/inbox_ops/emails/{id}

Auth requiredinbox_ops.proposals.manage

DELETE /inbox_ops/emails/{id}

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/emails/{id}/reprocess

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/emails/{id}/reprocess

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id/reprocess" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/extract

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/extract

Requires features: inbox_ops.proposals.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/extract" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals

Auth requiredinbox_ops.proposals.view

GET /inbox_ops/proposals

Requires features: inbox_ops.proposals.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals/{id}

Auth requiredinbox_ops.proposals.view

GET /inbox_ops/proposals/{id}

Requires features: inbox_ops.proposals.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/accept-all

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/proposals/{id}/accept-all

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/accept-all" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/proposals/{id}/actions/{actionId}

Auth requiredinbox_ops.proposals.manage

PATCH /inbox_ops/proposals/{id}/actions/{actionId}

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/actions/{actionId}/accept

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/proposals/{id}/actions/{actionId}/accept

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/accept" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/proposals/{id}/actions/{actionId}/complete

Auth requiredinbox_ops.proposals.manage

PATCH /inbox_ops/proposals/{id}/actions/{actionId}/complete

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/complete" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/actions/{actionId}/reject

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/proposals/{id}/actions/{actionId}/reject

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/reject" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/categorize

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/proposals/{id}/categorize

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/categorize" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/reject

Auth requiredinbox_ops.proposals.manage

POST /inbox_ops/proposals/{id}/reject

Requires features: inbox_ops.proposals.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/reject" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/replies/{replyId}/send

Auth requiredinbox_ops.replies.send

POST /inbox_ops/proposals/{id}/replies/{replyId}/send

Requires features: inbox_ops.replies.send

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
replyId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/replies/:replyId/send" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/translate

Auth requiredinbox_ops.proposals.view

POST /inbox_ops/proposals/{id}/translate

Requires features: inbox_ops.proposals.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/translate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals/counts

Auth requiredinbox_ops.proposals.view

GET /inbox_ops/proposals/counts

Requires features: inbox_ops.proposals.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/counts" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/settings

Auth requiredinbox_ops.settings.manage

GET /inbox_ops/settings

Requires features: inbox_ops.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/settings

Auth requiredinbox_ops.settings.manage

PATCH /inbox_ops/settings

Requires features: inbox_ops.settings.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/webhook/inbound

POST /inbox_ops/webhook/inbound

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/webhook/inbound" \
  -H "Accept: application/json"

Payment Gateways

Showing 10 of 10 endpoints

POST/payment_gateways/cancel

Auth requiredpayment_gateways.manage

POST /payment_gateways/cancel

Requires features: payment_gateways.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/capture

Auth requiredpayment_gateways.capture

POST /payment_gateways/capture

Requires features: payment_gateways.capture

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/capture" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/providers

Auth requiredpayment_gateways.view

GET /payment_gateways/providers

Requires features: payment_gateways.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/providers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/providers/{providerKey}

Auth requiredpayment_gateways.view

GET /payment_gateways/providers/{providerKey}

Requires features: payment_gateways.view

Parameters

Name	In	Required	Schema	Description
providerKey	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/providers/:providerKey" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/refund

Auth requiredpayment_gateways.refund

POST /payment_gateways/refund

Requires features: payment_gateways.refund

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/refund" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/sessions

Auth requiredpayment_gateways.manage

POST /payment_gateways/sessions

Requires features: payment_gateways.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/sessions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/status

Auth requiredpayment_gateways.view

GET /payment_gateways/status

Requires features: payment_gateways.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/transactions

Auth requiredpayment_gateways.view

GET /payment_gateways/transactions

Requires features: payment_gateways.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/transactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/transactions/{id}

Auth requiredpayment_gateways.view

GET /payment_gateways/transactions/{id}

Requires features: payment_gateways.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/transactions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/webhook/{provider}

POST /payment_gateways/webhook/{provider}

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/webhook/:provider" \
  -H "Accept: application/json"

Checkout

Showing 18 of 18 endpoints

GET/checkout/links

Auth requiredcheckout.view

GET /checkout/links

Requires features: checkout.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/links" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/checkout/links

Auth requiredcheckout.create

POST /checkout/links

Requires features: checkout.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/links" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/links/{id}

Auth requiredcheckout.view

GET /checkout/links/{id}

Requires features: checkout.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/checkout/links/{id}

Auth requiredcheckout.edit

PUT /checkout/links/{id}

Requires features: checkout.edit

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/checkout/links/{id}

Auth requiredcheckout.delete

DELETE /checkout/links/{id}

Requires features: checkout.delete

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/pay/{slug}

GET /checkout/pay/{slug}

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug" \
  -H "Accept: application/json"

GET/checkout/pay/{slug}/status/{transactionId}

GET /checkout/pay/{slug}/status/{transactionId}

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—
transactionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/status/:transactionId" \
  -H "Accept: application/json"

POST/checkout/pay/{slug}/submit

POST /checkout/pay/{slug}/submit

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/submit" \
  -H "Accept: application/json"

POST/checkout/pay/{slug}/verify-password

POST /checkout/pay/{slug}/verify-password

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/verify-password" \
  -H "Accept: application/json"

GET/checkout/templates

Auth requiredcheckout.view

GET /checkout/templates

Requires features: checkout.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/checkout/templates

Auth requiredcheckout.create

POST /checkout/templates

Requires features: checkout.create

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/templates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/templates/{id}

Auth requiredcheckout.view

GET /checkout/templates/{id}

Requires features: checkout.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/checkout/templates/{id}

Auth requiredcheckout.edit

PUT /checkout/templates/{id}

Requires features: checkout.edit

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/checkout/templates/{id}

Auth requiredcheckout.delete

DELETE /checkout/templates/{id}

Requires features: checkout.delete

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/templates/{id}/preview

Auth requiredcheckout.view

GET /checkout/templates/{id}/preview

Requires features: checkout.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates/:id/preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions

Auth requiredcheckout.view

GET /checkout/transactions

Requires features: checkout.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions/{id}

Auth requiredcheckout.view

GET /checkout/transactions/{id}

Requires features: checkout.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions/by-gateway/{gatewayTransactionId}

Auth requiredcheckout.view

GET /checkout/transactions/by-gateway/{gatewayTransactionId}

Requires features: checkout.view

Parameters

Name	In	Required	Schema	Description
gatewayTransactionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions/by-gateway/:gatewayTransactionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Akeneo Product Sync

Showing 6 of 6 endpoints

GET/sync_akeneo/custom-fields

Auth requireddata_sync.configure

GET /sync_akeneo/custom-fields

Requires features: data_sync.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/custom-fields" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/custom-fields

Auth requireddata_sync.configure

POST /sync_akeneo/custom-fields

Requires features: data_sync.configure

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/custom-fields" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/delete-products

Auth requireddata_sync.configure

POST /sync_akeneo/delete-products

Requires features: data_sync.configure

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/delete-products" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_akeneo/discovery

Auth requireddata_sync.configure

GET /sync_akeneo/discovery

Requires features: data_sync.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/discovery" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_akeneo/first-import

Auth requireddata_sync.configure

GET /sync_akeneo/first-import

Requires features: data_sync.configure

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/first-import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/first-import

Auth requireddata_sync.run

POST /sync_akeneo/first-import

Requires features: data_sync.run

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/first-import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Shipping Carriers

Showing 7 of 7 endpoints

POST/shipping-carriers/cancel

Auth requiredshipping_carriers.manage

POST /shipping-carriers/cancel

Requires features: shipping_carriers.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/points

Auth requiredshipping_carriers.view

GET /shipping-carriers/points

Requires features: shipping_carriers.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/points" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/providers

Auth requiredshipping_carriers.manage

GET /shipping-carriers/providers

Requires features: shipping_carriers.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/providers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/rates

Auth requiredshipping_carriers.manage

POST /shipping-carriers/rates

Requires features: shipping_carriers.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/shipments

Auth requiredshipping_carriers.manage

POST /shipping-carriers/shipments

Requires features: shipping_carriers.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/shipments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/tracking

Auth requiredshipping_carriers.view

GET /shipping-carriers/tracking

Requires features: shipping_carriers.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/tracking" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/webhook/{provider}

POST /shipping-carriers/webhook/{provider}

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/webhook/:provider" \
  -H "Accept: application/json"

Webhooks

Showing 20 of 24 endpoints

GET/webhooks

Auth requiredwebhooks.view

GET /webhooks

Requires features: webhooks.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks

Auth requiredwebhooks.manage

POST /webhooks

Requires features: webhooks.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/{id}

GET /webhooks/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/:id" \
  -H "Accept: application/json"

PUT/webhooks/{id}

PUT /webhooks/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/webhooks/:id" \
  -H "Accept: application/json"

DELETE/webhooks/{id}

DELETE /webhooks/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/webhooks/:id" \
  -H "Accept: application/json"

POST/webhooks/{id}/rotate-secret

POST /webhooks/{id}/rotate-secret

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/:id/rotate-secret" \
  -H "Accept: application/json"

POST/webhooks/{id}/test

POST /webhooks/{id}/test

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/:id/test" \
  -H "Accept: application/json"

GET/webhooks/deliveries

GET /webhooks/deliveries

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/deliveries" \
  -H "Accept: application/json"

GET/webhooks/deliveries/{id}

GET /webhooks/deliveries/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/deliveries/:id" \
  -H "Accept: application/json"

POST/webhooks/deliveries/{id}/retry

POST /webhooks/deliveries/{id}/retry

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/deliveries/:id/retry" \
  -H "Accept: application/json"

GET/webhooks/events

Auth requiredwebhooks.view

GET /webhooks/events

Requires features: webhooks.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/inbound/{endpointId}

POST /webhooks/inbound/{endpointId}

Parameters

Name	In	Required	Schema	Description
endpointId	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/inbound/:endpointId" \
  -H "Accept: application/json"

GET/webhooks/webhook-deliveries

Auth requiredwebhooks.view

GET /webhooks/webhook-deliveries

Requires features: webhooks.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhook-deliveries/{id}

Auth requiredwebhooks.view

GET /webhooks/webhook-deliveries/{id}

Requires features: webhooks.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/webhook-deliveries/{id}/retry

Auth requiredwebhooks.manage

POST /webhooks/webhook-deliveries/{id}/retry

Requires features: webhooks.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries/:id/retry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhooks

Auth requiredwebhooks.view

GET /webhooks/webhooks

Requires features: webhooks.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/webhooks

Auth requiredwebhooks.manage

POST /webhooks/webhooks

Requires features: webhooks.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/webhooks/webhooks

Auth requiredwebhooks.manage

PUT /webhooks/webhooks

Requires features: webhooks.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/webhooks/webhooks

Auth requiredwebhooks.manage

DELETE /webhooks/webhooks

Requires features: webhooks.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhooks/{id}

Auth requiredwebhooks.view

GET /webhooks/webhooks/{id}

Requires features: webhooks.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Customer Identity & Portal Authentication

Showing 20 of 50 endpoints

GET/customer_accounts/admin/domain-mappings

Auth requiredcustomer_accounts.domain.manage

GET /customer_accounts/admin/domain-mappings

Requires features: customer_accounts.domain.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings

Auth requiredcustomer_accounts.domain.manage

POST /customer_accounts/admin/domain-mappings

Requires features: customer_accounts.domain.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/customer_accounts/admin/domain-mappings

Auth requiredcustomer_accounts.domain.manage

DELETE /customer_accounts/admin/domain-mappings

Requires features: customer_accounts.domain.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings/{id}/health-check

Auth requiredcustomer_accounts.domain.manage

POST /customer_accounts/admin/domain-mappings/{id}/health-check

Requires features: customer_accounts.domain.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings/:id/health-check" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings/{id}/verify

Auth requiredcustomer_accounts.domain.manage

POST /customer_accounts/admin/domain-mappings/{id}/verify

Requires features: customer_accounts.domain.manage

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings/:id/verify" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customer_accounts/admin/roles

GET /customer_accounts/admin/roles

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles" \
  -H "Accept: application/json"

POST/customer_accounts/admin/roles

POST /customer_accounts/admin/roles

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles" \
  -H "Accept: application/json"

GET/customer_accounts/admin/roles/{id}

GET /customer_accounts/admin/roles/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/roles/{id}

PUT /customer_accounts/admin/roles/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \
  -H "Accept: application/json"

DELETE/customer_accounts/admin/roles/{id}

DELETE /customer_accounts/admin/roles/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/roles/{id}/acl

PUT /customer_accounts/admin/roles/{id}/acl

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id/acl" \
  -H "Accept: application/json"

GET/customer_accounts/admin/users

GET /customer_accounts/admin/users

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users

POST /customer_accounts/admin/users

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users-invite

POST /customer_accounts/admin/users-invite

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users-invite" \
  -H "Accept: application/json"

GET/customer_accounts/admin/users/{id}

GET /customer_accounts/admin/users/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/users/{id}

PUT /customer_accounts/admin/users/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \
  -H "Accept: application/json"

DELETE/customer_accounts/admin/users/{id}

DELETE /customer_accounts/admin/users/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users/{id}/reset-password

POST /customer_accounts/admin/users/{id}/reset-password

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/reset-password" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users/{id}/send-reset-link

POST /customer_accounts/admin/users/{id}/send-reset-link

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/send-reset-link" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users/{id}/verify-email

POST /customer_accounts/admin/users/{id}/verify-email

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/verify-email" \
  -H "Accept: application/json"

Example Module

Showing 18 of 18 endpoints

GET/example/assignees

Auth requiredexample.todos.view

GET /example/assignees

Requires features: example.todos.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/assignees" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/example/assignees

Auth requiredexample.todos.manage

POST /example/assignees

Requires features: example.todos.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example/assignees" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/blog/{id}

Auth requiredexample.todos.view

GET /example/blog/{id}

Requires features: example.todos.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/blog/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/example/blog/{id}

Auth requiredexample.todos.view

POST /example/blog/{id}

Requires features: example.todos.view

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example/blog/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/customer-priorities

Auth requiredexample.view

GET /example/customer-priorities

Requires features: example.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/example/customer-priorities

Auth requiredexample.todos.manage

POST /example/customer-priorities

Requires features: example.todos.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/example/customer-priorities

Auth requiredexample.todos.manage

PUT /example/customer-priorities

Requires features: example.todos.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/example/customer-priorities

Auth requiredexample.todos.manage

DELETE /example/customer-priorities

Requires features: example.todos.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/example/notifications

Auth requiredexample.todos.manage

POST /example/notifications

Requires features: example.todos.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example/notifications" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/organizations

Auth requiredexample.todos.view

GET /example/organizations

Requires features: example.todos.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/organizations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/override-probe

GET /example/override-probe

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/override-probe" \
  -H "Accept: application/json"

GET/example/qa-events

Auth requiredexample.view

GET /example/qa-events

Requires features: example.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/qa-events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/example/qa-events

Auth requiredexample.view

DELETE /example/qa-events

Requires features: example.view

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/qa-events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/tags

Auth requiredexample.todos.view

GET /example/tags

Requires features: example.todos.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/tags" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/example/todos

Auth requiredexample.todos.view

GET /example/todos

Requires features: example.todos.view

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example/todos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/example/todos

Auth requiredexample.todos.manage

POST /example/todos

Requires features: example.todos.manage

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example/todos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/example/todos

Auth requiredexample.todos.manage

PUT /example/todos

Requires features: example.todos.manage

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://om.3.74.75.141.nip.io/api/example/todos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/example/todos

Auth requiredexample.todos.manage

DELETE /example/todos

Requires features: example.todos.manage

Responses

204Success

No response body.

Example

curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/todos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Ratelimit Probe

Showing 1 of 1 endpoints

POST/ratelimit_probe/ping

POST /ratelimit_probe/ping

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/ratelimit_probe/ping" \
  -H "Accept: application/json"

Example Customers Sync

Showing 2 of 2 endpoints

GET/example-customers-sync/mappings

GET /example-customers-sync/mappings

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://om.3.74.75.141.nip.io/api/example-customers-sync/mappings" \
  -H "Accept: application/json"

POST/example-customers-sync/reconcile

POST /example-customers-sync/reconcile

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://om.3.74.75.141.nip.io/api/example-customers-sync/reconcile" \
  -H "Accept: application/json"

OpenAPI Explorer

Admin Dashboards

GET /dashboards/layout

Responses

Example

PUT /dashboards/layout

Responses

Example

PATCH /dashboards/layout/{itemId}

Parameters

Responses

Example

GET /dashboards/roles/widgets

Responses

Example

PUT /dashboards/roles/widgets

Responses

Example

GET /dashboards/users/widgets

Responses

Example

PUT /dashboards/users/widgets

Responses

Example

GET /dashboards/widgets/catalog

Responses

Example

POST /dashboards/widgets/data

Responses

Example

POST /dashboards/widgets/data/batch

Responses

Example

Authentication & Accounts

GET /auth/admin/nav

Responses

Example

POST /auth/feature-check

Responses

Example

GET /auth/features

Responses

Example

GET /auth/locale

Responses

Example

POST /auth/locale

Responses

Example

POST /auth/login

Responses

Example

POST /auth/logout

Responses

Example

GET /auth/profile

Responses

Example

PUT /auth/profile

Responses

Example

POST /auth/reset

Responses

Example

POST /auth/reset/confirm

Responses

Example

GET /auth/roles

Responses

Example

POST /auth/roles

Responses

Example

PUT /auth/roles

Responses

Example

DELETE /auth/roles

Responses

Example

GET /auth/roles/acl