Skip to main content
GET
/
api
/
subjects
List all subjects
curl --request GET \
  --url http://localhost/api/api/subjects \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "client_subject_id": "<string>",
      "subject_name": "<string>",
      "unique_identification_number": "<string>",
      "account_holder": true,
      "address": "<string>",
      "customer_segment": "<string>",
      "date_and_place_of_birth": "<string>",
      "country_of_birth_or_incorporation": "<string>",
      "nationality": "<string>",
      "account_type": "<string>",
      "account_type_ii": "<string>",
      "account_opening_date": "<string>",
      "account_opening_date_ii": "<string>",
      "customer_aml_risk_rating": "<string>",
      "customer_account": "<string>",
      "customer_account_ii": "<string>",
      "customer_opening_date": "<string>",
      "source_of_funds": "<string>",
      "average_monthly_income": "<string>",
      "cif_status": "<string>",
      "occupation": "<string>",
      "industry": "<string>",
      "purpose_of_account": "<string>",
      "contact_number": "<string>",
      "email_address": "<string>",
      "risk_assessment_score": "<string>",
      "created_by": 123,
      "modified_by": 123
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

Customer (used in this doc) and Subject (used in the API/backend) mean the same thing: one individual.
This is to retrieve a list of all existing customers

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
client_subject_id
string

Filter by client subject ID.

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
subject_name
string

Filter by subject name.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"