Members
The workspace's members, for setting a person column.
List the workspace's members
The people in the workspace, owner first and then by when they joined, and its seats. A person column holds a member's userId. A key gets what any member sees: no invitations, and isYou is false for everyone.
Who can call: Any API key.
Answer200 OK
membersarray of Memberrequired
The workspace's members, owner first, then by when they joined.
Show 6 fieldsHide 6 fields
idstringrequired
The membership's ID. A person column takes
userId, not this.userIdstringrequired
The person's user ID: what a person column holds, and the
actorIdof the changes they make.namestringrequired
The person's name. Can be empty.
emailstringrequired
The person's email address.
- Format
email
- Format
rolestringrequired
The person's role in the workspace:
owner,adminormember.- One of
"owner","admin","member"
- One of
isYoubooleanrequired
True for the signed-in person reading the list. Always false for an API key.
seatsobjectrequired
The workspace's seats.
Show 2 fieldsHide 2 fields
usedintegerrequired
Seats in use: the members plus the invitations still waiting.
- At least 0
limitinteger or nullrequired
The most seats the workspace can use, or null for no limit.
- At least 0
invitationsarray of objectoptional
The invitations still waiting, oldest first. Only for owners and admins signed in to the app: an API key's answer never has it.
Show 5 fieldsHide 5 fields
idstringrequired
The invitation's ID.
emailstringrequired
The address it was sent to.
- Format
email
- Format
rolestringrequired
The role the person gets on joining:
adminormember.- One of
"admin","member"
- One of
sentAtstringrequired
When it was sent, in UTC.
- Format
date-time(ISO 8601)
- Format
expiresAtstringrequired
When it stops working, in UTC.
- Format
date-time(ISO 8601)
- Format
Errors
UNAUTHENTICATED401 Unauthorized
No key was sent, or the key does not work: the header is not
Bearer <key>, the key is from another environment, unknown, revoked or expired, or its maker is no longer an owner or admin or its workspace is not active. The answer is the same in every case; when the request had anAuthorizationheader, it comes withWWW-Authenticate: Bearer.RATE_LIMITED429 Too Many Requests
Too many calls in the last 60 seconds: by the key, by its workspace's keys together, or from your address with keys that do not work. Only keys of the right shape count against your address; a header or key of the wrong shape answers 401 and is not counted. Send it again after
Retry-Afterseconds.With
Retry-After: 10, the seconds to wait before sending again.INTERNAL500 Internal Server Error
Something went wrong on our side. Try again later.
Example
curl "https://api.melonforce.com/v1/workspace/members" \
-H "Authorization: Bearer $MELONFORCE_API_KEY"{
"members": [
{
"id": "Fh2kP9qLm4XzR7tWc1VbN8sJd3GyA6uE",
"userId": "Q3vR7nX2kLp9sT4wYb8mZc1dF6gHj0aE",
"name": "Dana Reyes",
"email": "dana@example.com",
"role": "owner",
"isYou": false
},
{
"id": "a8TnW3eYq6Rk1Lm5Zp0Xc9Vb2Hd7Gs4J",
"userId": "M7bX1cQ8vN4kT2wR9pL6sZ3yH0fJ5gDa",
"name": "Sam Ortiz",
"email": "sam@example.com",
"role": "member",
"isYou": false
}
],
"seats": {
"used": 2,
"limit": 10
}
}