List users
curl --request GET \
--url https://api.myabode.ca/v1/users \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.myabode.ca/v1/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.myabode.ca/v1/users"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"object": "user",
"id": "<string>",
"name": "<string>",
"memberships": [
{
"brokerage": "<string>",
"name": "<string>",
"email": "<string>",
"status": "active",
"roles": [
{
"role": "system_admin",
"scope": {
"type": "brokerage",
"id": "<string>"
}
}
],
"office": "<string>",
"team": "<string>"
}
]
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}API Reference
List users
The membership filters (brokerage, status, office, role) must all hold on the same membership. id returns the readable users among up to 100 ids. Requires users:read.
GET
/
v1
/
users
List users
curl --request GET \
--url https://api.myabode.ca/v1/users \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.myabode.ca/v1/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.myabode.ca/v1/users"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"object": "user",
"id": "<string>",
"name": "<string>",
"memberships": [
{
"brokerage": "<string>",
"name": "<string>",
"email": "<string>",
"status": "active",
"roles": [
{
"role": "system_admin",
"scope": {
"type": "brokerage",
"id": "<string>"
}
}
],
"office": "<string>",
"team": "<string>"
}
]
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>",
"resource": "<string>"
}
]
}Authorizations
An API key of the form mya_…, sent as Authorization: Bearer mya_…. The secret is shown once, when the key is created.
Query Parameters
Maximum array length:
100Minimum string length:
1Maximum array length:
100Minimum string length:
1Membership status. New values may be added; this is not a breaking change. Handle unknown values.
Available options:
active, inactive Minimum string length:
1Maximum array length:
100Role. New values may be added; this is not a breaking change. Handle unknown values.
Available options:
system_admin, org_admin, brokerage_admin, office_admin, team_leader, deal_processor, closing_processor, listing_processor, deal_processor_manager, agent, assistant Opaque: send back a next_cursor unchanged.
Minimum string length:
1Required range:
1 <= x <= 100