Members
List all Members
Members
List all Members
GET
/
members
curl --request GET \
--url https://api.sandbox.goteal.co/members \
--header 'X-API-KEY: <api-key>'
{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"members": [
{
"email": "john.smith@goteal.co",
"role": "Owner",
"name": "John Smith",
"status": "unconfirmed",
"mfa_status": "sms"
}
]
}
Authorizations
Query Parameters
The offset to start at
Required range:
x >= 1
The number of items to return
Required range:
1 <= x <= 100
Response
200
application/json
OK
Example:
"john.smith@goteal.co"
The Role of the Member
Example:
"Owner"
the status of the Member
Available options:
unconfirmed
, confirmed
, archived
, compromised
, unknown
, reset_required
, force_change_password
, external_provider
Example:
"unconfirmed"
the status of the Member
Available options:
sms
, email
, disabled
Example:
"sms"
Names of the Member
Example:
"John Smith"
curl --request GET \
--url https://api.sandbox.goteal.co/members \
--header 'X-API-KEY: <api-key>'
{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"members": [
{
"email": "john.smith@goteal.co",
"role": "Owner",
"name": "John Smith",
"status": "unconfirmed",
"mfa_status": "sms"
}
]
}