Account

The credential you are calling with, and what it can reach.

Retrieve the current credential

GET

https://api.wearenoe.fr/v1

/me

Bearer

Returns the workspace, integration, scopes, property restriction and rate limits for the key you are calling with. Use it to verify a key and discover what it can reach.

Retrieve the current credential › Headers

X-Noe-App

string

Your integration key. Verified against the key you authenticated with; a mismatch is rejected.

Retrieve the current credential › Responses

The calling credential.

object

string · enum · required

Enum values:

credential

api_version

string · required

The API version your responses are shaped for.

environment

string · enum · required

Which environment this key belongs to.

Enum values:

live

test

object · required

The workspace this key reads and writes.

MeIntegration · required

scopes

string[] · required

What this key can actually do: the intersection of what Noé approved for the integration, what the workspace consented to, and what the key itself was given.

ScopeDescriptor[] · required

The same scopes, explained — handy for rendering a permissions screen.

property_scope

array | null · required

Property ids you are restricted to. Null means the whole workspace, including properties added later.

MeRateLimits · required

GET/me

curl https://api.wearenoe.fr/v1/me \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "object": "credential",
  "api_version": "2026-08-01",
  "environment": "live",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "slug": "conciergerie-du-lac"
  },
  "integration": {
    "key": "jaffichecomplet",
    "name": "J'affiche Complet"
  },
  "scopes": [
    "properties:read",
    "calendar:read",
    "calendar:write"
  ],
  "scope_details": [
    {
      "key": "reservations:guest_read",
      "label": "Guest identity",
      "description": "Read the name, email and phone of the guest on a reservation.",
      "sensitive": true,
      "write": false
    }
  ],
  "property_scope": null,
  "rate_limits": {
    "per_minute": 300,
    "per_day": 20000
  }
}

json

application/json

Changelog Properties

Retrieve the current credential

GET

https://api.wearenoe.fr/v1

/me

Bearer

Returns the workspace, integration, scopes, property restriction and rate limits for the key you are calling with. Use it to verify a key and discover what it can reach.

Retrieve the current credential › Headers

X-Noe-App

string

Your integration key. Verified against the key you authenticated with; a mismatch is rejected.

Retrieve the current credential › Responses

The calling credential.

object

string · enum · required

Enum values:

credential

api_version

string · required

The API version your responses are shaped for.

environment

string · enum · required

Which environment this key belongs to.

Enum values:

live

test

object · required

The workspace this key reads and writes.

MeIntegration · required

scopes

string[] · required

What this key can actually do: the intersection of what Noé approved for the integration, what the workspace consented to, and what the key itself was given.

ScopeDescriptor[] · required

The same scopes, explained — handy for rendering a permissions screen.

property_scope

array | null · required

Property ids you are restricted to. Null means the whole workspace, including properties added later.

MeRateLimits · required