Skip to main content
GET
/
api
/
v1
/
profiles
/
{profile_id}
/
addresses
List addresses for a profile
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{profile_id}/addresses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "address",
      "attributes": {
        "custom_fields": {},
        "label": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_line3": "<string>",
        "address_level1": "<string>",
        "address_level2": "<string>",
        "address_level3": "<string>",
        "address_level4": "<string>",
        "country": "<string>",
        "country_name": "<string>",
        "postal_code": "<string>",
        "effective_from": "2023-12-25",
        "effective_to": "2023-12-25"
      },
      "relationships": {
        "profile": {
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          },
          "meta": {}
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Path Parameters

profile_id
string
required

Profile UUID

Query Parameters

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

addresses found

data
object[]
required
I