GET /api/v1/addon
Personal access token & O auth2

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[category] string

    Filter by addon category (accepts both enum value and display name).

  • per_page integer

    the amount of addon subscriptions per page (Default 15. Max 500).

  • sort string

    Field to sort by. Valid fields are [name]. Negative sign to denote DESC. Defaults to 'name'.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • id string
      • name string
      • description string
      • setup_instructions string
      • category string
      • params object
        Hide params attributes Show params attributes object
        • access_code object
          Hide access_code attributes Show access_code attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
        • pin object
          Hide pin attributes Show pin attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
        • second_access_code object
          Hide second_access_code attributes Show second_access_code attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
        • second_pin object
          Hide second_pin attributes Show second_pin attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
        • third_access_code object
          Hide third_access_code attributes Show third_access_code attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
        • third_pin object
          Hide third_pin attributes Show third_pin attributes object
          • type string
          • description string
          • example string
          • options array
          • required boolean
          • inputs array
          • list_type string
          • attributes array
      • banner_url string
      • icon_url string
      • price object
        Hide price attributes Show price attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • can_be_subscribed_to boolean
      • is_visible boolean
      • free_trial_days integer
      • should_poll_for_subscription_changes boolean
GET /api/v1/addon 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/addon' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    [
      {
        "id": "transact_valuation_feed",
        "name": "Transact Valuation Feed",
        "price": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "params": {
          "pin": {
            "type": "text",
            "inputs": [],
            "example": "secret-password-123",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "TRDS Password (Not Your Transact Password)"
          },
          "third_pin": {
            "type": "text",
            "inputs": [],
            "example": "secret-password-123",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "Third TRDS Password (Not Your Transact Password)"
          },
          "second_pin": {
            "type": "text",
            "inputs": [],
            "example": "secret-password-123",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "Second TRDS Password (Not Your Transact Password)"
          },
          "access_code": {
            "type": "text",
            "inputs": [],
            "example": "555-123-456",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "Transact Number"
          },
          "third_access_code": {
            "type": "text",
            "inputs": [],
            "example": "555-123-456",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "Third Transact Number"
          },
          "second_access_code": {
            "type": "text",
            "inputs": [],
            "example": "555-123-456",
            "options": [],
            "required": false,
            "list_type": null,
            "attributes": [],
            "description": "Second Transact Number"
          }
        },
        "category": "valuation_feed_integration",
        "icon_url": "https://plannrcrm.com/icon.png",
        "banner_url": "https://plannrcrm.com/banner.png",
        "is_visible": true,
        "description": "Provides an automatic holding and valuation feed via a transact integration",
        "free_trial_days": 30,
        "setup_instructions": "Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/",
        "can_be_subscribed_to": true,
        "should_poll_for_subscription_changes": true
      }
    ]
  ]
}