Get the caller's team
Returns the caller's team: its name, the caller's role, members (display names and roles only), seat usage, and, for an owner or admin, pending invites with masked addresses. `team` is null when the caller is not on a team.
bearerAuthAuthorizationBearer <token>A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.
Get the caller's team
application/json- response
team*|null when the caller is not on a team.
curl -X GET 'https://app.falconryscale.com/api/v1/team'{
"team": {
"id": "string",
"name": "string",
"myRole": "owner",
"seatsUsed": -9007199254740991,
"seatsTotal": -9007199254740991,
"overLimit": true,
"members": [
{
"membershipId": "string",
"name": "string",
"role": "owner",
"joinedAt": "string",
"isMe": true
}
],
"pendingInvites": [
{
"inviteId": "string",
"emailMasked": "string",
"role": "admin",
"expiresAt": "string",
"expired": true,
"emailStatus": "queued"
}
]
}
}Update a document’s details
Edits a document's details (title, dates, issuing authority, tags, expiry reminders, which raptor it belongs to). The file itself can't be changed through the API. Only the fields you send change; null clears an optional field.
Invite someone to the team
Owner or admin only. Sends a team invite EMAIL to the given address (this is the one tool that emails someone) and holds a seat for 14 days. Never call it on your own initiative: repeat the exact address and role back to the user and confirm before calling. Fails with 409 when the team is full or the address already has a pending invite, and with 429 after 5 invite changes (invites plus revokes) in an hour or 20 in a day. The invite code is not returned: the invitee joins from the email.