List phone numbers - Scholarly API Documentation

List phone numbers

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": {
        "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"
          }
        }
      }
    }
  ]
}

GET

api

phone_numbers

List phone numbers

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": {
        "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"
          }
        }
      }
    }
  ]
}

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

Query Parameters

filter[phone_number]

string

filter[phone_number.neq]

string

filter[phone_number.cont]

string

Case-insensitive substring match

filter[phone_number.in]

string

Comma-separated list

filter[phone_number.nin]

string

Comma-separated list

filter[external_id]

string

filter[external_id.neq]

string

filter[external_id.cont]

string

Case-insensitive substring match

filter[external_id.in]

string

Comma-separated list

filter[external_id.nin]

string

Comma-separated list

filter[effective_from]

string