List records | Parallel Developer Documentation

This is unreleased documentation for Parallel Developer Documentation Next 🚧 version.

For up-to-date documentation, see the latest version (Current – v2.x).

Version: Next 🚧

Endpoints

These endpoints can be used to retrieve a list of all businesses or individuals in your case management account.

HTTP Request

Query Parameters

Pagination parameters (Optional).

Parameter Description
cursor (string) Optional. A pagination cursor value.
limit (integer) Optional. Limit the number of records returned per page.
archived (boolean) Optional. Scope the records returned by their archived status. All records are returned if the parameter is not provided.
- true - Only return archived records.
- false - Only return non-archived records.
email (string) Optional. Scope the records returned by a wildcard search on their current email. Only applicable for the /individuals endpoint.

Response Parameters

Parameter Description
data An array of Record objects, sorted in ascending order of the record's insertion date.
pagination A Pagination object containing a next_cursor value that can be used in a subsequent API call to obtain the next page of records.

Note: If risk rating is configured in your account, the current_status object in each record will include a risk_rating property with level and value attributes.

Example Response

{
  "data": [
    {
      "id": "UG9kVXNlclJlY29yZDox",
      "type": "individual",
      "archived_at": null,
      "external_id": "12",
      "ref_code": null,
      "identity_link_established_at": "2023-06-04T20:07:58Z",
      "identity_link_expiration_requested_by": null,
      "identity_link_expires_at": null,
      "user_requested_deletion_at": null,
      "created_at": "2023-06-04T20:07:58Z",
      "current_status": {
        "status": "open",
        "source": "system",
        "notes": null,
        "set_by": {
          "email": "joe@acme.com",
          "first_name": "Joe",
          "last_name": "Bloggs"
        },
        "set_at": "2023-06-04T20:07:58Z",
        "risk_rating": {
          "level": "low",
          "value": 20
        }
      },
      "user_deactivated_at": null
    }
  ],
  "pagination": {
    "next_cursor": "MTE="
  }
}

{
  "data": [
    {
      "id": "UG9kQnVzaW5lc3NSZWNvcmQ6MQ==",
      "type": "business",
      "archived_at": null,
      "external_id": "22",
      "ref_code": null,
      "identity_link_established_at": null,
      "identity_link_expiration_requested_by": null,
      "identity_link_expires_at": null,
      "created_at": "2023-06-04T20:07:59Z",
      "current_status": {
        "status": "open",
        "source": "system",
        "notes": null,
        "set_by": {
          "email": "joe@acme.com",
          "first_name": "Joe",
          "last_name": "Bloggs"
        },
        "set_at": "2023-06-04T20:07:59Z",
        "risk_rating": {
          "level": "medium",
          "value": 50
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "MTE="
  }
}