me

Mock

Mock. This operation is part of the approved contract but its module is not built yet. Run Core with N1_API_MODE=mock N1_DEV_AUTH=stub to get deterministic demo-shop data from it. The real server answers NOT_IMPLEMENTED until it ships; the schema and examples here will not change when it does.

The signed-in person, their shop and permissions

Compare

The signed-in person, their shop and their permissions. Call it once after sign-in; use permissions to show or hide controls.

POST/graphqlapp audience

Who can call this. Any signed-in shop user. You can run it against Local or Staging from the request panel, with a demo-shop token.

Headers

Required Optional

AuthorizationstringRequired
Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.
Example: Bearer eyJhbGciOiJFZERTQSJ9…
Content-TypestringRequired
Always application/json. Only POST is accepted.
Example: application/json
X-Request-IdstringOptional
Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.
Example: app-7f3c2a9e-checkout

Arguments

This operation takes no arguments.

Returns

Required Optional

meMe!Required
The signed-in person, their shop and their permissions. Call it once after sign-in; use permissions to show or hide controls.
Show children
- organisationOrganisation!Required
  The caller’s shop.
  Example: {"id":"0192f0c1-0000-7000-8000-00000000000a","name":"Demo Precision Works","timezone":"Asia/Kolkata"}
  Show children
  - addressAddress!Required
    Registered address.
    Show children
    cityString!Required
    City or town.
    line1String!Required
    Building, street.
    line2StringOptional
    Area, landmark.
    pincodeString!Required
    6-digit PIN code.
    stateString!Required
    State name.
  - fyStartMonthInt!Required
    Month the financial year starts, 1–12 (4 = April).
  - gstinStringOptional
    GSTIN, if registered.
  - idID!Required
    The shop id (the tenant).
    Example: "0192f0c1-0000-7000-8000-00000000000a"
  - invoicePrefixString!Required
    Prefix of invoice numbers.
  - nameString!Required
    Trade name.
    Example: "Demo Precision Works"
  - stateCodeString!Required
    GST state code (2 digits); decides CGST+SGST or IGST.
  - timezoneString!Required
    IANA timezone people read times in.
    Example: "Asia/Kolkata"
- permissions[String!]!Required
  Actions the caller may perform; hide controls that are not here.
  Example: ["org.read","org.manage","users.read","users.manage","customers.read","customers.write","customers.delete"]
- userUser!Required
  The caller.
  Example: {"id":"0192f0c1-0000-7000-8000-0000000000a1","name":"Asha Demo","role":"OWNER"}
  Show children
  - createdAtString!Required
    UTC time the user was added.
  - emailStringOptional
    Sign-in email, if any.
  - idID!Required
    Stable id (UUIDv7).
    Example: "0192f0c1-0000-7000-8000-0000000000a1"
  - lastLoginAtStringOptional
    UTC time of the last sign-in; null if never.
  - nameString!Required
    Full name.
    Example: "Asha Demo"
  - phoneStringOptional
    Sign-in phone, if any.
  - roleRoleName!Required
    Their role in this shop.
    Example: "OWNER"
    ACCOUNTANTCustomers, invoices and payments.
    ADMINManages people, settings and customers on the owner’s behalf.
    OPERATORRuns machines and logs production.
    OWNERRuns the shop. Everything, including who else can sign in.
    QCInspects parts and records results.
    SUPERVISORPlans and watches the shop floor.
  - statusUserStatus!Required
    Whether they can sign in.
    ACTIVECan sign in.
    INACTIVECannot sign in; their sessions were revoked. History stays.

Errors

This operation has no documented error responses.

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.