API Resource: Custom Attributes

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 Attributes represent custom attributes for relationships that have been created in your MonkeyPod database. 

There is one supported endpoint for entity attributes:

  1. Retrieve a collection of all custom attributes

Retrieve a Collection of All Custom Attributes

Method: GET

Endpoint: https://[YOUR-SUBDOMAIN].monkeypod.io/api/v2/entity_attributes

Sample request:

GET https://my-org.monkeypod.io/api/v2/entity_attributes

Sample response:

{
  "data": [
    {
      "name": "Costume Color", 
      "slug": "costume-color", 
      "type": "string", 
      "form": "select_other", 
      "choices": [
        "Blue", 
        "Red", 
        "Green", 
        "Yellow"
      ], 
      "created_at": "2022-04-11T22:31:32.000000Z", 
      "updated_at": "2022-04-11T22:31:32.000000Z"
    }, {
      "name": "Discovered Superpowers", 
      "slug": "discovered-superpowers", 
      "type": "string", 
      "form": "datepicker", 
      "choices": null, 
      "created_at": "2022-04-11T22:31:32.000000Z", 
      "updated_at": "2022-04-11T22:31:32.000000Z"
    }, {
      "name": "Secret Identity?", 
      "slug": "secret-identity", 
      "type": "boolean", 
      "form": "checkbox_boolean", 
      "choices": null, 
      "created_at": "2022-04-11T22:31:32.000000Z", 
      "updated_at": "2022-04-11T22:31:32.000000Z"
    }
  ], 
  "links": {
    "first": "https://my-org.monkeypod.io/api/v2/entity_attributes?page=1",
    "last": "https://my-org.monkeypod.io/api/v2/entity_attributes?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://my-org.monkeypod.io/api/v2/entity_attributes",
    "per_page": 15,
    "to": 3,
    "total": 3
  }
}