API Resource: Entity Phones

Heads up! MonkeyPod's API is only available to Enterprise users and requires significant technical expertise to use. The API is considered to be in "beta" and remains under active development. We will make reasonable efforts to ensure its stability, but make no guarantees, warranties, or promises with respect to its availability or performance. 

Entity Phones represent phone numbers for relationships in MonkeyPod. 

There are three supported endpoints for entity phones:

1. Retrieve a collection of phone numbers for a specific entity
2. Retrieve a single phone number
3. Delete a phone number

Retrieve a Collection of Phones for a Specific Entity

Method: GET

Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entities/[ENTITY-ID]/phones

Sample request:

GET https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones

Sample response:

{
  "data": [
    {
      "id": "96509f02-3bc8-4aee-967f-3443bb69052a",
       "type": "Home", 
      "number": "555-1234"
    }, {
      "id": "96509f02-3c4e-48a4-ae91-1cb2b87feeff",
      "type": "Cell",
      "number": "555-4321"
    }
  ],
  "links": {
    "first": "https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones?page=1",
    "last": "https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Retrieve a Single Phone

Method: GET

Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entities/[ENTITY-ID]/phones/[PHONE-ID]

Sample request:

GET https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones/96509f02-3bc8-4aee-967f-3443bb69052a

Sample response:

{
  "id":"9650a0fb-c1e8-4820-be96-38a5aed35925",
  "resource":"entity_phone",
  "data": {
    "id":"9650a0fb-c1e8-4820-be96-38a5aed35925",
    "type":"Home",
    "number":"555-1234",
    "created_at":"2022-05-16T19:47:04.000000Z",
    "updated_at":"2022-05-16T19:47:04.000000Z"
  }
}

Delete Phone

Method: DELETE

Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entities/[ENTITY-ID]/phones/[PHONE-ID]

Sample request:

DELETE https://my-org.monkeypod.io/api/v2/entities/960a735b-3ee9-4440-9c6d-25cbf27c77fe/phones/96509f02-3bc8-4aee-967f-3443bb69052a

Successful delete requests respond with HTTP status code 204 and an empty response body.