cURL
curl --request GET \ --url https://api.scholarlysoftware.com/api/v1/phone_numbers \ --header 'Authorization: Bearer <token>'
{ "data": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "type": "phone_number", "attributes": { "label": "home", "phone_number": "+14155559012", "effective_from": "2023-12-25", "custom_fields": {}, "external_id": "EXT-12345", "effective_to": "2023-12-25" }, "relationships": { "profile": { "links": { "related": "<string>" }, "meta": {}, "data": { "type": "profile", "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } } } } ] }
Returns a list of phone numbers
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
phone numbers found
Show child attributes
"phone_number"
"home"
The phone number in E.164 format
"+14155559012"
External identifier for this phone number
"EXT-12345"
"profile"