Skip to Content
webagent docs
API reference

Team

Members, roles and invitations.

Open as .md
GET
/v1/team

Members and pending invitations of the caller's org (a signed-in person)

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Response Body

OK

application/json
  1. response
members*array<>
invitations*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/team'
Example Response
{  "members": [    {      "userId": "string",      "email": "string",      "name": "string",      "role": "owner",      "joinedAt": 0    }  ],  "invitations": [    {      "id": "string",      "email": "string",      "role": "owner",      "status": "pending",      "expiresAt": 0,      "invitedBy": "string"    }  ]}
POST
/v1/team/invitations

Invite someone by email with a role; identity emails the link (admin or owner)

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json
  1. body
email*string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254
role?string
Default"member"
Value in"owner""admin""member"

Response Body

OK

application/json
  1. response
id*string
Length1 <= length
email*string
role*string
Value in"owner""admin""member"
status*string
Value in"pending""accepted""rejected""canceled""expired"
expiresAt*integer
Range0 <= value <= 9007199254740991
invitedBy*string|null
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/team/invitations' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
{  "id": "string",  "email": "string",  "role": "owner",  "status": "pending",  "expiresAt": 0,  "invitedBy": "string"}
DELETE
/v1/team/invitations/{id}

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

id*string
Length1 <= length

Response Body

OK

application/json
  1. response
deleted*boolean
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/team/invitations/string'
Example Response
{  "deleted": true}

Change a member's role

PATCH
/v1/team/members/{userId}

Change a member's role (admin or owner; only an owner makes or changes an owner); applies to their dashboard sessions at once

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

userId*string
Length1 <= length

Request Body

application/json
  1. body
role*string
Value in"owner""admin""member"

Response Body

OK

application/json
  1. response
userId*string
Length1 <= length
email*string
name*string|null
role*string
Value in"owner""admin""member"
joinedAt*integer
Range0 <= value <= 9007199254740991
Example Request
curl -X PATCH 'https://api.us.webagent.lookover.ai/v1/team/members/string' \  -H 'Content-Type: application/json' \  -d '{  "role": "owner"}'
Example Response
{  "userId": "string",  "email": "string",  "name": "string",  "role": "owner",  "joinedAt": 0}
DELETE
/v1/team/members/{userId}

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

userId*string
Length1 <= length

Response Body

OK

application/json
  1. response
deleted*boolean
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/team/members/string'
Example Response
{  "deleted": true}