Members

List members

GET/v1/workspaces/{workspaceId}/members

The workspace's members with their role and brand access, the owner first. See Brand access.

curl "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/members" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

[
  {
    "userId": "tjkfq4cpgb1c6746gmaw2gyd67qvn2hj",
    "email": "orders@luigispizza.com",
    "name": "Luigi's Pizza",
    "role": "owner",
    "brandIds": [
      "khs69yxwyr7kw03m5j1v7qmhdvknj6ac"
    ],
    "otherBrands": false,
    "keysGoOnRemoval": false
  }
]

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

Response

A list of objects.

userIdstringrequired
emailstringrequired
namestring or nullrequired
roleenumrequired
One of "owner", "member"
brandIdsarray of string or nullrequired
The only brands this member sees, or null when they see every brand. Set it with PATCH /v1/workspaces/{workspaceId}/members/{userId}/brand-access. If you are limited to some brands yourself, this lists only brands you also see.
otherBrandsbooleanrequired
True when every brand this member is limited to is one you don't see.
keysGoOnRemovalbooleanrequired
True when the member is limited to some brands. Removing such a member also revokes their API keys.

Errors answer with a status and the error shape.