cURL
curl --request GET \ --url https://api.scholarlysoftware.com/api/v1/addresses \ --header 'Authorization: Bearer <token>'
{ "data": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "type": "address", "attributes": { "label": "Office Address", "address_level1": "IL", "address_level2": "Springfield", "effective_from": "2024-01-01", "custom_fields": {}, "external_id": "EXT-12345", "address_line1": "789 Academic Dr", "address_line2": "Suite 200", "address_line3": "<string>", "address_level3": "<string>", "address_level4": "<string>", "country": "US", "country_name": "United States", "postal_code": "62703", "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" } } } } ] }
Returns a list of addresses
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Bearer token
Number of items per page (max 100)
Cursor for next page
Cursor for previous page
addresses found
Show child attributes