Case Notes API

Retrieve external case notes for a service provider or client.

---

Base Information

• Namespace: wedatatools/v1
• Allowed Methods: GET

Endpoint

Path

/wp-json/wedatatools/v1/external/case-notes

Full URL (example)

https://example.com/wp-json/wedatatools/v1/external/case-notes

Method

GET

---

Authorization

This endpoint requires authentication using an application key issued for a specific user.

Authentication Method

Requests are authenticated using HTTP Basic Authentication.

• Username: the username provided to you
• Password: the application key provided to you

The application key functions as a dedicated API credential and is used in place of an account password.

Request Example

Example using curl:

curl -u username:application-key \
  "https://example.com/wp-json/wedatatools/v1/external/case-notes"

This sends an Authorization header in the following form:

Authorization: Basic base64(username:application-key)

Security Notes

• Application keys should be kept secret and treated like passwords.
• Requests must be made over HTTPS to protect credentials in transit.
• Do not embed application keys directly in client-side code.

Error Responses

If authentication fails, the API will return one of the following:

• 401 Unauthorized – missing or invalid credentials
• 403 Forbidden – credentials are valid but lack permission to access this resource

---

Query Parameters

Parameter	Type	Required	Default	Constraints	Description
clientReferenceNumber	string (nullable)	No	null	Format: text-field	Return case notes for a specific client by their CaMS Client Reference Number.
fromDate	string (nullable)	No	null	Format: date-time (ISO8601)	Return case notes created after the specified date (ISO8601 format).
perPage	integer	No	20	Min: 1, Max: 100	How many case note results to return in a given request.
page	integer	No	1	Min: 1	Specify the page number of the results.
sort	string	No	date-desc	Allowed: date-desc, date-asc	Specify a strategy to order the results.

---

Response Structure

A successful request returns a JSON array of case note objects. Each object has the following shape:

Field	Type	Description
id	integer	Primary key. The unique identifier for the case note in the WeJobs portal. Use this field for mapping and deduplication.
name	string	A human-readable label for the case note (e.g. Case Note #302045).
slug	string	A URL-safe identifier for the case note (e.g. staging-302045).
date	string	The date and time the case note was created, in YYYY-MM-DD HH:MM:SS format.
client	object	The client associated with the case note. Contains id (integer), name (string), and clientReferenceNumber (string — the CaMS reference number).
author	object	The staff member who created the case note. Contains id (string) and name (string).
activityTypes	array	A list of activity type objects. Each entry contains id (integer) and name (string).
excerpt	string	A plain-text summary of the case note content.
content	string	The full case note body as an HTML string.

Primary Key / Unique ID

The id field is the primary key for each case note and is unique across the Jobs portal. This is the recommended field to use when storing, mapping, or deduplicating records on your end.

Example Response Item

{
	"id": 302045,
	"name": "Case Note #302045",
	"slug": "staging-302045",
	"date": "2026-01-19 13:21:53",
	"client": {
		"name": "Adam Bishop",
		"id": 280,
		"clientReferenceNumber": "7735299"
	},
	"author": {
		"name": "Jane Smith",
		"id": "15"
	},
	"activityTypes": [
		{
			"name": "Safety Flag",
			"id": 66349
		}
	],
	"excerpt": "Safety flag added: Test Flag Service Provider: Case Notes API Test",
	"content": "<p>Safety flag added: Test Flag<br />\nService Provider: Case Notes API Test</p>\n"
} ​

Examples

1) Default request

GET /wp-json/wedatatools/v1/external/case-notes

2) Filter by client reference number

GET /wp-json/wedatatools/v1/external/case-notes?clientReferenceNumber=123456

3) Pagination + sorting

GET /wp-json/wedatatools/v1/external/case-notes?perPage=50&page=2&sort=date-asc

4) Filter by creation date

Return case notes created after January 1, 2024 (ISO8601 format).

GET /wp-json/wedatatools/v1/external/case-notes?fromDate=2024-01-01T00:00:00Z

Notes

• If clientReferenceNumber is omitted, the endpoint returns case notes without filtering by client.
• perPage is capped at 100.
• Use sort=date-desc for newest-first (default) or sort=date-asc for oldest-first.