Profiles

A Swish profile is the entity to which Items and Lists belong.

post

Authorizations

Swish API keybearer

HTTPRequired

Body

application/json

emailstringRequired

The email of the profile to identify

Example: [email protected]

Responses

200

The profile has been identified

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/profiles/identify

HTTPcURLJavaScriptPython

POST /api/2025-04/profiles/identify HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "email": "[email protected]"
}

{
  "data": {
    "authFlow": "/customer_authentication/login"
  }
}

post

Authorizations

Swish API keybearer

HTTPRequired

Body

application/json

customerstringOptional

A customer GID to create a token for.

Example: gid://shopify/Customer/1234567890

sessionstringOptional

A session GID to link to the customer.

Example: gid://swish/Session/abc123

Responses

201

The token has been created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/profiles/token

HTTPcURLJavaScriptPython

POST /api/2025-04/profiles/token HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "customer": "gid://shopify/Customer/1234567890",
  "session": "gid://swish/Session/abc123"
}

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "profile": "gid://swish/Session/abc123"
  }
}