v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB

Internal Endpoints

List all internal endpoints

This operation lists all internal endpoints which organizations can use to communicate with. This includes all Spruce phone numbers, fax numbers, email addresses and Spruce Links. You can then use an internal endpoint to send a message.

get/internalendpoints

Response

Expected response to a valid request

Example response

{
  "internalEndpoints": [
    {
      "additionalMembers": [
        {
          "displayName": "John Doe, MD",
          "email": "provider@example.com",
          "id": "entity_0E5QDGJC03000",
          "type": "teammate"
        }
      ],
      "owner": {
        "displayName": "John Doe, MD",
        "email": "provider@example.com",
        "id": "entity_0E5QDGJC03000",
        "type": "teammate"
      }
    }
  ]
}