Skip to content
GetmeDocs
Sign inCreate account

Getting started

  • Getme developer documentation

API Reference

  • Introduction
  • Authentication
  • Errors
  • Idempotent requests
  • Metadata
  • Pagination
  • Request IDs
  • Versioning
  • Webhooks
  • Event Catalog
  • SDKs and CLI

Core Resources

  • Auth
  • Events

Site Resources

  • Forms
  • Sites

Commerce Resources

  • Brands
  • Categories
  • Products
  • Services

Crm Resources

  • Customers

Other Resources

  • Media

Dev Tools

  • CLIBeta
  • Website source with the CLIBeta
  • Webhooks with the CLIBeta
  • SDKsBeta
  • Node SDKBeta
  • Python SDKBeta

Guides

  • Guides
  • Quickstart
  • Website source workflow
  • Webhook handler

Changelog

  • Changelog
  • June 10, 2026 - Developer platform docs beta
  • July 15, 2026 - Install token lifecycle safety
  • July 15, 2026 - Source-first site development
  • July 15, 2026 - Site source navigation warnings
Loading documentation...
HomeAPI referenceAuth

Auth

Core Resources · 3 endpoints

POST/v1/auth/device/code

Create Device Authorization

public_device_authorization

Request body · application/json

FieldTypeRequiredDescription
client_namestringoptional

Returns · 200

FieldTypeRequiredDescription
dataDeviceAuthorizationCreateResponserequired
data.device_codestringrequired
data.expires_inintegerrequired
data.intervalintegerrequired
data.object
string
optional
device_authorization
data.user_codestringrequired
data.verification_uristringrequired
data.verification_uri_completestringrequired
successbooleanrequiredtrue

Errors 400401403404409422429500

cURL
curl https://api.getmeonline.io/v1/auth/device/code \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "client_name": "client_name"
  }'
POST/v1/auth/device/token

Poll Device Authorization

public_device_authorization

Request body · application/json

FieldTypeRequiredDescription
device_codestringrequired

Returns · 200

FieldTypeRequiredDescription
dataDeviceAuthorizationTokenResponserequired
data.errorstringoptional
data.intervalintegerrequired
data.objectstringoptionaldevice_authorization_token
data.profile_hintstringoptional
data.raw_keystringoptional
data.statusstringrequired
successbooleanrequiredtrue

Errors 400401403404409422429500

cURL
curl https://api.getmeonline.io/v1/auth/device/token \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "device_code": "device_code"
  }'
GET/v1/auth/status

Auth Status

app_install_bearer

Returns · 200

FieldTypeRequiredDescription
dataDeveloperAuthStatusObjectrequired
data.appstringoptionalDeveloper app public identifier for app-install tokens.
data.app_installstringoptionalApp install public identifier for app-install tokens.
data.authenticatedbooleanoptional
data.companystringoptionalCompany public identifier for the token scope.
data.credential_typestringrequired
data.environmentstringrequired
data.idstringrequiredAPI key public identifier.
data.namestringoptional
data.objectstringoptionaldeveloper_auth_status
data.rate_limitintegerrequired
data.scopesstring[]optional
successbooleanrequiredtrue

Errors 400401403404409422429500

cURL
curl https://api.getmeonline.io/v1/auth/status \
  -H "Authorization: Bearer $GETME_API_KEY"

On this page

  • Create Device Authorization
  • Poll Device Authorization
  • Auth Status