Retrieve an office
curl --request GET \
--url https://api.myabode.ca/v1/offices/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.myabode.ca/v1/offices/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.myabode.ca/v1/offices/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "office",
"id": "<string>",
"brokerage": "<string>",
"name": "<string>",
"teams": [
{
"id": "<string>",
"name": "<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
Retrieve an office
An absent office and one this key cannot read both return 404 NOT_FOUND. Requires offices:read.
GET
/
v1
/
offices
/
{id}
Retrieve an office
curl --request GET \
--url https://api.myabode.ca/v1/offices/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.myabode.ca/v1/offices/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.myabode.ca/v1/offices/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "office",
"id": "<string>",
"brokerage": "<string>",
"name": "<string>",
"teams": [
{
"id": "<string>",
"name": "<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.
Path Parameters
Minimum string length:
1