Account

Finish signing in

POST/v1/me/sync

Copies the signed-in person's WorkOS profile to their account and their workspace memberships from WorkOS (an accepted invite shows up here), and makes a first workspace for someone new. The app calls it once per session. It fails with 403 email_not_verified until WorkOS has verified the person's email. Only works from the app, not with an API key. See Owner-only and app-only.

curl -X POST "$AYEFORM_API/v1/me/sync" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

200 Response

{
  "userId": "tjkfq4cpgb1c6746gmaw2gyd67qvn2hj",
  "email": "orders@luigispizza.com",
  "isNewAccount": true,
  "workspaces": [
    {
      "id": "q9vxefwe62t8njyxv1pjr1vdq9s1awap",
      "name": "Luigi's Pizza",
      "role": "owner"
    }
  ],
  "gate": "invite_only",
  "joinedWorkspaceId": "frbsdb8pbhfdd6p06tmtwzbtm9wpr8a9"
}

Response

userIdstringrequired
emailstringrequired
isNewAccountbooleanrequired
workspacesarray of objectrequired
Every workspace they're in, with their role.
Show 3 fieldsHide 3 fields
- idstringrequired
- namestringrequired
- roleenumrequired
  One of "owner", "member"
gateenum or nullrequired
invite_only for someone who is in no workspace and may not create one. Null otherwise.
joinedWorkspaceIdstring or nullrequired
A workspace this sync added them to through an accepted invite, or null.

Errors answer with a status and the error shape.