Method
GET
Search Endpoint
https://api.callcap.com/v2/get/callsurance/csrs/
Query accessible CSRs ("Agents" or Employees)
Resource Endpoint
https://api.callcap.com/v2/get/callsurance/csrs/<csr_id>/
Returns data for a single CSR

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
search_term Freeform query parameter. search_term is checked against CSR name. Slightly fuzzy-search such that search_term="john" will return CSRs like "John Smith" and "Dave Johnson". (None) String

Example JSON response (formatted for clarity)

{
      "status": "success",
      "csr":
      [
        {
          "csr_id": 0,
          "csr_name": "Administrator",
          "access": "global"
        },
        {
          "csr_id": 57423,
          "csr_name": "Alison",
          "access":
          [
            {
              "account_type": "corporate",
              "account_id": 1
            },
            {
              "account_type": "location",
              "account_id": 20
            },
            {
              "account_type": "location",
              "account_id": 25
            }
          ]
        },
        ...
        {

          "csr_id": 98564,
          "csr_name": "John",
          "access":
          [
            {
              "account_type": "corporate",
              "account_id": 1
            },
            {
              "account_type": "location",
              "account_id": 30
            },
            {
              "account_type": "location",
              "account_id": 35
            }
          ]
        }
      ]
    }
    
  • status is a string attribute present on every response and will be "success" when a successful request is completed.
  • csr is an array of objects, with each object containing details on a specific CSR, including csr_id, csr_name and an "access" array.
  • access is an array of objects, with each object containing details on a specific Account that the CSR "has access to" (can take calls for).