1. OpenAPI (Demo)
  2. Identity
  3. Create a member session
ReadmeGitHub
  • Platform API overview
  • Quickstart
  • POSTCreate a member session
  • POSTRefresh a member session
  • DELETERevoke a member session
  • GETList organizations
  • POSTCreate an organization
  • GETGet an organization
  • PATCHUpdate an organization
  • GETList organization members
  • POSTInvite an organization member
  • DELETERemove an organization member
  • PATCHUpdate a member role
  • GETList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEArchive a project
  • PATCHUpdate a project
  • GETList project environments
  • POSTCreate a project environment
  • GETList project documents
  • POSTCreate a project document
  • GETGet a document
  • DELETEArchive a document
  • PATCHUpdate a document
  • POSTPublish a document
  • GETList contacts
  • POSTCreate a contact
  • GETGet a contact
  • DELETEDelete a contact
  • PATCHUpdate a contact
  • GETList product events
  • GETGet analytics overview
  • GETList workflows
  • POSTCreate a workflow
  • GETList workflow runs
  • GETList webhook subscriptions
  • POSTCreate a webhook subscription
  • GETGet a webhook subscription
  • DELETEDelete a webhook subscription
  • PATCHUpdate a webhook subscription
  • GETList webhook deliveries
  • POSTReplay a webhook delivery
  • GETList files
  • POSTCreate a multipart file upload
  • GETGet file metadata
  • DELETEDelete a file
  • GETGet current subscription
  • PATCHUpdate subscription settings
  • GETList invoices
  • GETGet metered usage
  • GETList API keys
  • POSTCreate an API key
  • POSTRevoke an API key
  • GETList audit logs
  • GETList exports
  • POSTCreate an export
  • GETGet API health
POST/auth/sessions

Create a member session

Exchanges mock credentials for a short-lived member access token and a refresh token.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Request body

application/jsonrequired
emailstring · emailrequired
passwordstring · passwordrequired
device_namestringoptional

Responses

201application/json

Session created.

{
  "id": "ses_01J8F0ZK3E9X",
  "access_token": "heyo_demo_01J8F2X6ZJ5Q3F7A4K9N",
  "refresh_token": "refresh_demo_01J8F0ZK3E9X",
  "expires_at": "2026-09-03T14:40:12Z",
  "member": {
    "id": "mem_01J8F3D2P9Q7V6N5M4K",
    "email": "mira@northstar.example",
    "role": "admin"
  }
}
idstringoptional
access_tokenstringoptional
refresh_tokenstringoptional
expires_atstring · date-timeoptional
memberobjectoptional
401application/json

Credentials were rejected.

{
  "error": {
    "code": "validation_failed",
    "message": "One or more fields need attention.",
    "details": [
      {
        "path": "name",
        "code": "too_short",
        "message": "Use at least 3 characters."
      }
    ]
  },
  "request_id": "req_01J8F6C4YTP8B2S9QK1M"
}
errorrequired
request_idstringrequired
429

Too many sign-in attempts.

Quickstart< PreviousRefresh a member sessionNext >

Powered by heyo

curl --request POST \  'https://api.demo.heyo.example/v3/auth/sessions' \  --header 'Content-Type: application/json' \  --data '{  "email": "mira@northstar.example",  "password": "demo-only-password",  "device_name": "Mira’s MacBook Pro"}'
{  "id": "ses_01J8F0ZK3E9X",  "access_token": "heyo_demo_01J8F2X6ZJ5Q3F7A4K9N",  "refresh_token": "refresh_demo_01J8F0ZK3E9X",  "expires_at": "2026-09-03T14:40:12Z",  "member": {    "id": "mem_01J8F3D2P9Q7V6N5M4K",    "email": "mira@northstar.example",    "role": "admin"  }}