Callsurance Minors

Method

GET

Search Endpoint

https://api.callcap.com/v2/get/callsurance/minors/

Query available Callsurance Minors (Results)

Parameters

Note: All parameters are optional and have useful defaults

Name	Description	Default	Accepted values
corporate_id	One Callcap top level "Corporate" account ID	(No restriction)	Numeric; Corporate account ID your login has access to
division_id	Any amount of Callcap 2nd level "Division" account IDs	(No restriction)	Numeric; Division account IDs your login has access to
location_id	Any amount of Callcap 3rd level "Location" account IDs	(No restriction)	Numeric; Location account IDs your login has access to
major_id	A list of Callsurance major IDs for which you'd like to limit calls	(No restriction)	Comma-delimited list of numeric Callsurance major IDs; Comma delimited list of any/all/none of the following: 1 (Positive calls) 2 (Negative calls) 3 (Neutral calls)
minor_id	The numeric minor_id for one minor. If specified, only details for this minor are returned.	(No restriction)	Numeric; One minor_id corresponding to a Callsurance minor that you have access to.
search_term	Freeform query parameter. search_term is checked against the Minor label. Slightly fuzzy-search such that search_term="Appointment" will find "Appointment booked" and "Could not book Appointment".	(None)	String
last_modified_start	The earliest date in a date range for which you'd like to search minors last modified	(No restriction) *Note: if no time is added, the time will default to midnight	Date and time string in the format yyyy-mm-dd HH:nn
last_modified_end	The latest date in a date range for which you'd like to search minors last modified	(No restriction) *Note: if no time is added, the time will default to 23:59:59	Date and time string in the format yyyy-mm-dd HH:nn
page	Specify the page of data to view. Paging is based on the total number of records from your request and the amount of records shown per page.	1	Numeric; Greater than 1, less than or equal to the last_page parameter returned.
show	Specify how many records to show per page.	50	Numeric; Greater than 0, less than or equal to 1000

Example JSON response (formatted for clarity)

{
	"status": "success",
	"pagination": {
			"records_returned": 357,
			"last_page": 3,
			"total_records": 357,
			"page": 2,
			"show": 150
	},
	"minor":
	[
		{
			"minor_id": 156374,
			"minor_label": "Abandoned Call",
			"major_id": 2,
			"last_modified": "2021-10-12 20:08:41",
			"parent_minor_id": 0,
			"accounts":
			{
				"location_id": 20,
				"division_id": 15,
				"corporate_id": 1
			}
		},
		...
		{
			"minor_id": 452364,
			"minor_label": "Wrong Number",
			"major_id": 3,
			"parent_minor_id": 0,
			"accounts":
			{
				"location_id": 35,
				"division_id": 15,
				"corporate_id": 1
			}
		}
	]
}

• status is a string attribute present on every response and will be "success" when a successful request is completed.
• pagination is an object with attributes describing how to page through the data.
• minor is an array of objects, with each object containing details on a specific Callsurance Minor, including an "accounts" object.
• accounts is an object, containing the Account IDs which have access to the requested Callsurance Minor.