Skip to main content
GET
/
v1
/
profiles
List profiles
curl --request GET \
  --url https://clm-svc.gominerva.com/v1/v1/profiles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "msg": "OK",
  "result": {
    "meta": {
      "currentPage": 1,
      "nextPage": 2,
      "perPage": 1,
      "prevPage": 0,
      "totalPages": 659,
      "totalRows": 659
    },
    "profiles": [
      {
        "_v": 1,
        "address1": "1234 Fake St",
        "address2": "Apt 123",
        "addressCity": "Toronto",
        "addressPostalCode": "A1B2C3",
        "addressState": "ON",
        "allowlistUntil": "2024/08/15",
        "archived": false,
        "country": "Canada",
        "createdAt": "2024-08-06T20:02:12.876Z",
        "dateOfBirth": "YYYY/MM/DD",
        "email": "[email protected]",
        "externalId": "external-customer-id",
        "firstName": "John",
        "flags": [
          {
            "count": 2,
            "kind": "screeningPepMatch"
          }
        ],
        "id": "6501f2a5a8257eb952e041d4",
        "kind": "individual",
        "lastName": "Smith",
        "lastScreenedTime": "2024-08-15T14:43:02.805Z",
        "monitored": "monitored",
        "nationality": "Canada",
        "occupation": "",
        "organization": "",
        "phone": "",
        "sex": "M",
        "status": "potential_match",
        "tenantId": "ef637217-5fbf-4117-88f0-a9f1246ffe7f",
        "updatedAt": "2024-08-15T14:43:02.805Z"
      }
    ]
  },
  "status": 200
}

Authorizations

​
x-api-key
string
header
required

Minerva API key must be provided in the x-api-key header for all API endpoints

Query Parameters

​
page
integer
default:1

The current page cursor to fetch, starting at 1

​
perPage
integer
default:20

The number of records to fetch per page, max 100

​
query
string

A generic string to filter by. This will check against all the various profile fields and return profiles that match any fields to the string. Partial matches will be returned.

​
external_id
string

Filter by profiles based on the externalId that was provided during the onboarding or profile creation API request. This field can be used to query for particular profiles using an ID from an external system such as a custom admin system or CRM.

​
name
string

Filter by partial matches to the full name.

​
address1
string

Filter by partial matches to address line 1.

​
address2
string

Filter by partial matches to address line 2.

​
date_of_birth
string

Filter by profiles with a certain date of birth, in \

​
sex
string

Filter by profiles with a certain sex, as reported on their onboarding documentation. Should be \

​
address_city
string

Filter by partial matches to the profile's known city of residence.

​
address_state
string

Filter by partial matches to the profiles' known state/province of residence.

​
country
string

Filter by partial matches to the profiles' known country of residence.

​
nationality
string

Filter by partial matches to a country of citizenship.

​
tasks
string

Filter by tasks (comma-separated)

​
kind
string

Filter by profile kind

​
status
string

Filter by profiles that are in a certain workflow status (example: \

​
archived
string

Filter by profiles based on archived status. Omit to show all profiles (default behaviour).

​
flag_names
string

Filter by profiles with certain flags (comma-separated). Example: \

​
last_screened_time_start
string

Filter by last screened time start

​
last_screened_time_end
string

Filter by last screened time end

​
monitored
string

Filter by monitored status

​
sort_key
string
default:createdAt

The key to sort records by. This should match an existing key on the profile schema. Default: \

​
sort_direction
string
default:desc

The direction to sort. Should be \

Body

application/json · object

Response

200 - application/json

Profiles listed successfully

​
msg
string
Example:

"OK"

​
result
object
​
status
integer
Example:

200