Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scholarlysoftware.com/api/v1/addresses/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scholarlysoftware.com/api/v1/addresses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": {},
"is_current": true,
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01",
"effective_to": "2023-12-25"
},
"relationships": {
"user": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"profile": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}Returns a specific address by UUID
curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scholarlysoftware.com/api/v1/addresses/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scholarlysoftware.com/api/v1/addresses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": {},
"is_current": true,
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01",
"effective_to": "2023-12-25"
},
"relationships": {
"user": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"profile": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer token
Comma-separated list of relationships to include. Allowed: user, profile
address found
Show child attributes