Getting Started

Requirements

You must have an active Agent Response (opens new window) subscription.

All plans with the exception of 'Essential Email' have access to the API.

Getting your authentication token

Once logged in to your active Agent Response account, go to the API Settings (opens new window) page and create a token.

You can give your token any name, e.g. Zapier Integration Token if you're planning on using our api with Zapier (opens new window).

Getting data for a specific office

Many of our API endpoints accept an office_id parameter. To find out the office id, go to the API Settings (opens new window) page and look under the Office IDs section.

Testing authentication

Once you have retrieved your API token. Confirm that it is correct by using the test credential endpoint.

Endpoint

• /completed-forms

Required Params

• api_token - String: Your API token

Optional Params

• office_id - Integer: The office you wish to get data for. For most endpoints this means retrieving data for all offices available to the user.

• cURL
• PHP
• Ruby

## Test Credentials Duplicate
curl "https://app.agentresponse.co.uk/api/test-credentials?api_token=YOUR_API_TOKEN&office_id=OFFICE_ID" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

<?php

// Include Guzzle. If using Composer:
// require 'vendor/autoload.php';

use GuzzleHttp\Pool;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();
$apiToken = "YOUR_API_TOKEN";
$officeId = OFFICE_ID; // optional

$request = new Request(
        "GET",
        "https://app.agentresponse.co.uk/api/test-credentials?api_token={$apiToken}&office_id={$officeId}",
        [
            "Content-Type" => "application/json",
            "Accept" => "application/json"
        ],
        "");

$response = $client->send($request);
echo "Response HTTP : " . $response->getStatusCode() . "
";

require 'net/http'
require 'net/https'

api_token = "YOUR_API_TOKEN"
office_id = nil

# Test Credentials Duplicate (GET )
def send_request
  uri = URI("https://app.agentresponse.co.uk/api/test-credentials?api_token=#{api_token}&office_id=#{office_id}")

  # Create client
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_PEER

  # Create Request
  req =  Net::HTTP::Get.new(uri)
  # Add headers
  req.add_field "Content-Type", "application/json"
  # Add headers
  req.add_field "Accept", "application/json"

  # Fetch Request
  res = http.request(req)
  puts "Response HTTP Status Code: #{res.code}"
  puts "Response HTTP Response Body: #{res.body}"
rescue StandardError => e
  puts "HTTP Request failed (#{e.message})"
end

Where next?

See the Examples and API sections for further reading.