API docs by Redocly

myne Connect Brands API (1.0.0)

Download OpenAPI specification:

License: Proprietary

Brand-scoped HTTP Basic API for partners (CRM, sync, credit). Use credentials from Custom API (Basic) in myne (username = client ID, password = secret). Base URL: connect.myne.network. Legacy api.myne.network/app/integration/* routes are deprecated.

Brands

Customer, business, sync, and CRM embed APIs

Browse customers for a brand

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
query Parameters
limit
integer
Default: 15
cursor
string
query
string
include_visitors
boolean

When true, include visitor records; default is known customers only.

Responses

Get a customer by id

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
customer_id
required
integer

Responses

List filter groups for a customer

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
customer_id
required
integer

Responses

Get extended customer profile

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
customer_id
required
integer

Responses

Get customer gift card balance and wallet pass identifiers

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
customer_id
required
integer

Responses

Add credit to a customer gift card

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
customer_id
required
integer
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Browse businesses for a brand

Authorizations:
basicAuth
path Parameters
brand_id
required
integer

Responses

Get a business by id

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
business_id
required
integer

Responses

Get extended business profile

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
business_id
required
integer

Responses

Batch upsert contacts, businesses, and links

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Mint a short-lived Bearer token for CRM embed

Authorizations:
basicAuth
path Parameters
brand_id
required
integer
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }