Working Feedback API v9.0.1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Working Feedback API allows system integrators and clients to directly interact with the Working Feedback service from your own application using a simple REST-based API.

All responses, including error messages, are returned in JSON.

All URLs are relative to our API base domain which is https://api9.workingfeedback.co.uk

Authentication

• HTTP Authentication, scheme: bearer
  

All API resources are protected and require an access token, which should be passed as a Bearer token in the Authorization header. You can generate a personal access token from your Working Feedback dashboard.

Feedback Requests

At the heart of Working Feedback are feedback requests - requests sent via email or SMS asking the recipient to leave feedback on their experience.

Working Feedback will handle the entire feedback request process from start to finish, meaning that integrators simply need to provide us the data necessary for creating a feedback request.

Create a new feedback request

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/x-www-form-urlencoded"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/request", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /request HTTP/1.1

Content-Type: application/x-www-form-urlencoded
Accept: application/json

const inputBody = '{
  "company": 0,
  "type": "email",
  "name": "string",
  "destination": "string",
  "platform": "workingfeedback",
  "businessName": "string",
  "jobTitle": "string",
  "source": "string",
  "treatmentType": "Unknown",
  "dateOfBirth": "string",
  "title": "string",
  "metadata": "string",
  "staffName": "string",
  "sendAfter": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/request',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/request', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/request',
  params: {
  }, headers: headers

p JSON.parse(result)

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/request', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /request

Creates a new email or SMS feedback request, queued for sending, with the given inputs.

Body parameter

company: 0
type: email
name: string
destination: string
platform: workingfeedback
businessName: string
jobTitle: string
source: string
treatmentType: Unknown
dateOfBirth: string
title: string
metadata: string
staffName: string
sendAfter: string

Parameters

Example responses

200 Response

{
  "id": 0,
  "type": "SMS",
  "olderThan28Days": true,
  "destination": "string",
  "source": "string",
  "treatmentType": "Unknown",
  "platform": "workingfeedback",
  "opened": true,
  "sent": true,
  "success": true,
  "published": true,
  "reminders": 0,
  "rv_id": 0,
  "title": "string",
  "author": "string",
  "metadata": "string",
  "dates": {
    "created": "string",
    "updated": "string",
    "sent": "string",
    "reviewSubmitted": "string",
    "reviewModerated": "string",
    "reviewPublished": "string"
  }
}

Responses

Get an existing feedback request

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/request/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /request/{id} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/request/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/request/{id}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/request/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/request/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /request/{id}

Retrieves the real-time state of an existing feedback request by ID.

Parameters

Example responses

200 Response

{
  "id": 0,
  "type": "SMS",
  "olderThan28Days": true,
  "destination": "string",
  "source": "string",
  "treatmentType": "Unknown",
  "platform": "workingfeedback",
  "opened": true,
  "sent": true,
  "success": true,
  "published": true,
  "reminders": 0,
  "rv_id": 0,
  "title": "string",
  "author": "string",
  "metadata": "string",
  "dates": {
    "created": "string",
    "updated": "string",
    "sent": "string",
    "reviewSubmitted": "string",
    "reviewModerated": "string",
    "reviewPublished": "string"
  }
}

Responses

List existing feedback requests

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/request/list/{companyId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /request/list/{companyId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/request/list/{companyId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/request/list/{companyId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/request/list/{companyId}',
  params: {
  }, headers: headers

p JSON.parse(result)

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/request/list/{companyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /request/list/{companyId}

Lists recent feedback requests for any given companyId.

Parameters

Example responses

200 Response

{
  "requests": [
    {
      "id": 0,
      "type": "SMS",
      "olderThan28Days": true,
      "destination": "string",
      "source": "string",
      "treatmentType": "Unknown",
      "platform": "workingfeedback",
      "opened": true,
      "sent": true,
      "success": true,
      "published": true,
      "reminders": 0,
      "rv_id": 0,
      "title": "string",
      "author": "string",
      "metadata": "string",
      "dates": {
        "created": "string",
        "updated": "string",
        "sent": "string",
        "reviewSubmitted": "string",
        "reviewModerated": "string",
        "reviewPublished": "string"
      }
    }
  ]
}

Responses

Response Schema

Status Code 200

Enumerated Values

Reviews

Reviews collected by Working Feedback can be managed through this API. This includes - where applicable - reviews from Google and recommendations from Facebook.

Note that reviews from third party platforms are prefixed with T for easy identification.

Get a specific review

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/review/{reviewId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /review/{reviewId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/review/{reviewId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/review/{reviewId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/review/{reviewId}',
  params: {
  }, headers: headers

p JSON.parse(result)

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/review/{reviewId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /review/{reviewId}

Get the review details (including private additional information) for a given reviewId. If no access token is passed then only publicly accessible fields are returned.

Parameters

Example responses

200 Response

{
  "id": "string",
  "status": "PUBLISHED",
  "author": {
    "name": "string",
    "job_title": "string",
    "business": "string",
    "email": "string"
  },
  "has_reply": true,
  "anonymous": true,
  "title": "string",
  "text": "string",
  "rating": {
    "score": 0,
    "percentage": 0
  },
  "dates": {
    "submitted": "string",
    "published": "string",
    "rejected": "string",
    "investigated": "string",
    "restricted": "string",
    "escalated": "string",
    "verified": "string",
    "moderated": "string",
    "nhs_submitted": "string",
    "nhs_accepted": "string",
    "nhs_rejected": "string"
  }
}

Responses

Get paginated company reviews

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "limit": []string{"0"},
        "dateFrom": []string{"string"},
        "dateTo": []string{"string"},
        "ratings": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/company/{companyId}/reviews/{status}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /company/{companyId}/reviews/{status} HTTP/1.1

Accept: application/json
limit: 0
dateFrom: string
dateTo: string
ratings: string

const headers = {
  'Accept':'application/json',
  'limit':'0',
  'dateFrom':'string',
  'dateTo':'string',
  'ratings':'string',
  'Authorization':'Bearer {access-token}'
};

fetch('/company/{companyId}/reviews/{status}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'limit': '0',
  'dateFrom': 'string',
  'dateTo': 'string',
  'ratings': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/company/{companyId}/reviews/{status}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'limit' => '0',
  'dateFrom' => 'string',
  'dateTo' => 'string',
  'ratings' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/company/{companyId}/reviews/{status}',
  params: {
  }, headers: headers

p JSON.parse(result)

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'limit' => '0',
    'dateFrom' => 'string',
    'dateTo' => 'string',
    'ratings' => 'string',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/company/{companyId}/reviews/{status}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /company/{companyId}/reviews/{status}

Get a paginated list of reviews for a given companyId, filtered by status and optionally dates and/or ratings.

Parameters

Enumerated Values

Example responses

200 Response

{
  "reviews": [
    {
      "id": "string",
      "status": "PUBLISHED",
      "author": {
        "name": "string",
        "job_title": "string",
        "business": "string",
        "email": "string"
      },
      "has_reply": true,
      "anonymous": true,
      "title": "string",
      "text": "string",
      "rating": {
        "score": 0,
        "percentage": 0
      },
      "dates": {
        "submitted": "string",
        "published": "string",
        "rejected": "string",
        "investigated": "string",
        "restricted": "string",
        "escalated": "string",
        "verified": "string",
        "moderated": "string",
        "nhs_submitted": "string",
        "nhs_accepted": "string",
        "nhs_rejected": "string"
      }
    }
  ]
}

Responses

Response Schema

Status Code 200

Enumerated Values

Schemas

FeedbackRequest

{
  "id": 0,
  "type": "SMS",
  "olderThan28Days": true,
  "destination": "string",
  "source": "string",
  "treatmentType": "Unknown",
  "platform": "workingfeedback",
  "opened": true,
  "sent": true,
  "success": true,
  "published": true,
  "reminders": 0,
  "rv_id": 0,
  "title": "string",
  "author": "string",
  "metadata": "string",
  "dates": {
    "created": "string",
    "updated": "string",
    "sent": "string",
    "reviewSubmitted": "string",
    "reviewModerated": "string",
    "reviewPublished": "string"
  }
}

Properties

Enumerated Values

FeedbackRequestInput

{
  "company": 0,
  "type": "email",
  "name": "string",
  "destination": "string",
  "platform": "workingfeedback",
  "businessName": "string",
  "jobTitle": "string",
  "source": "string",
  "treatmentType": "Unknown",
  "dateOfBirth": "string",
  "title": "string",
  "metadata": "string",
  "staffName": "string",
  "sendAfter": "string"
}

Properties

Enumerated Values

Review

{
  "id": "string",
  "status": "PUBLISHED",
  "author": {
    "name": "string",
    "job_title": "string",
    "business": "string",
    "email": "string"
  },
  "has_reply": true,
  "anonymous": true,
  "title": "string",
  "text": "string",
  "rating": {
    "score": 0,
    "percentage": 0
  },
  "dates": {
    "submitted": "string",
    "published": "string",
    "rejected": "string",
    "investigated": "string",
    "restricted": "string",
    "escalated": "string",
    "verified": "string",
    "moderated": "string",
    "nhs_submitted": "string",
    "nhs_accepted": "string",
    "nhs_rejected": "string"
  }
}

Properties

Enumerated Values

ErrorResponse

{
  "message": "string",
  "errors": {
    "key": "string",
    "value": "string"
  }
}

Properties

KeyValue

{
  "key": "string",
  "value": "string"
}

Properties