Get all addon subscriptions
Headers
-
Content-Type string
-
Accept string
Query parameters
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
per_page integer
the amount of addon subscriptions per page (Default 15. Max 500).
-
sort string
Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.
GET /api/v1/addon-subscriptions
curl \
-X GET https://api.plannrcrm.com/api/v1/addon-subscriptions \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"data": [
{
"uuid": "6494a9bc-a8d0-4d7a-be91-a342ba03e3cd",
"addon": {
"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,
"description": "TRDS Password (Not Your Transact Password)"
},
"third_pin": {
"type": "text",
"inputs": [],
"example": "secret-password-123",
"options": [],
"required": false,
"list_type": null,
"description": "Third TRDS Password (Not Your Transact Password)"
},
"second_pin": {
"type": "text",
"inputs": [],
"example": "secret-password-123",
"options": [],
"required": false,
"list_type": null,
"description": "Second TRDS Password (Not Your Transact Password)"
},
"access_code": {
"type": "text",
"inputs": [],
"example": "555-123-456",
"options": [],
"required": false,
"list_type": null,
"description": "Transact Number"
},
"third_access_code": {
"type": "text",
"inputs": [],
"example": "555-123-456",
"options": [],
"required": false,
"list_type": null,
"description": "Third Transact Number"
},
"second_access_code": {
"type": "text",
"inputs": [],
"example": "555-123-456",
"options": [],
"required": false,
"list_type": null,
"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",
"setup_instructions": "Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/",
"can_be_subscribed_to": true
},
"enabled": "true",
"created_at": "2024-11-20T13:24:04+00:00",
"updated_at": "2024-11-20T13:24:04+00:00"
}
]
}