SWFIAPI DocumentationPeople
top

People

The People module is a central component of the dashboard, providing valuable insights into the individuals involved in the transactions. This module consolidates data related to buyers, sellers, and other entities, enabling users to gain a comprehensive understanding of key stakeholders. The People module empowers users to explore the relationships between various entities, facilitating informed decision-making and fostering a deeper understanding of transaction dynamics.

Retrieve all People

Retrieve a list of People based on your query parameters.

Get/people

Query Parameters

before_created_at
TYPEstring
Restrict the response to people created_at before the set time.
after_created_at
TYPEstring
Restrict the response to people created_at after the set time.
before_updated_at
TYPEstring
Restrict the response to people updated_at before the set time.
after_updated_at
TYPEstring
Restrict the response to people updated_at after the set time.
first_name
TYPEstring
Restrict the response to people with the search phrase in the first_name field.
last_name
TYPEstring
Restrict the response to people with the search phrase in the last_name field.
name
TYPEstring
Restrict the response to people with the search phrase in the name field.
title
TYPEstring
Restrict the response to people with the search phrase in the history.title field.
email
TYPEinteger
Restrict the response to people that have an email address. Possible values: 0 and 1.
phone
TYPEinteger
Restrict the response to people that have a phone number. Possible values: 0 and 1.
linkedin
TYPEinteger
Restrict the response to people that have a LinkedIn® address. Possible values: 0 and 1.
entity_id
TYPEstring
Restrict the response to people that have job/board history at a valid entity_id. Field matches on "history.entity_id".
limit
TYPEinteger
The number of records to return. Default value is 10. Maximum value is 100.
offset
TYPEinteger
Used for pagination, this is the number of records from a collection to skip. Default value is 0.
sort_field
TYPEstring
Returns files sorted by the specified field. Possible values: "created_at", "updated_at", and "name". Default is "name".
sort_dir
TYPEstring
Determines the sort_field order direction of the results. Possible values: "ASC" or "DESC". Default is "ASC".
List People
curl -v -X GET https://api.swfi.com/v1/people?before_created_at=2022-10-17&after_created_at=2022-10-12&before_updated_at=2022-10-17&after_updated_at=2022-10-12&first_name=Gei&last_name=Ny&name=eir%20%C3%98iv&title=Chief%20Risk%20Off&email=1&phone=1&linkedin=1&entity_id=598cdaa60124e9fd2d05c04a&limit=10&offset=0&sort_field=name&sort_dir=ASC \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data
TYPEobject[]
An array of people.
total_items
TYPEinteger
The total number of items matching the query regardless of pagination.
Example response
{
  "data": [
    {
      "_id": "5b3173eea6e5a3f3b1ce4ec6",
      "first_name": "Geir",
      "last_name": "Nygård",
      "name": "Geir Nygård",
      "age": "",
      "phone": "",
      "email": "name@company.com",
      "gender": "Male",
      "nationality": "Norway",
      "country": "Norway",
      "region": "Europe",
      "city": "Oslo",
      "linkedin": "https://no.linkedin.com/in/geir-%C3%B8ivind-nyg%C3%A5rd",
      "created_at": "2018-06-25T23:01:32.588Z",
      "updated_at": "2022-01-12T18:14:50.539Z",
      "history": [
        {
          "active": true,
          "role": "job",
          "title": "Chief Asset Strategies Officer",
          "entity_id": "598cdaa60124e9fd2d05b9af",
          "started_at": "2020-09-07T00:00:00.000Z",
          "ended_at": "",
          "created_at": "2022-01-12T18:15:40.995Z",
          "updated_at": ""
        },
        {
          "active": false,
          "role": "job",
          "title": "Chief Investment Officer for Asset Strategies",
          "entity_id": "598cdaa60124e9fd2d05b9af",
          "started_at": "2016-12-01T00:00:00.000Z",
          "ended_at": "2020-08-05T00:00:00.000Z",
          "created_at": "2018-07-20T00:39:17.431Z",
          "updated_at": "2022-01-12T18:15:17.133Z"
        },
        {
          "active": false,
          "role": "job",
          "title": "Portfolio Manager in Equity Asset Strategies and other positions",
          "entity_id": "598cdaa60124e9fd2d05b9af",
          "started_at": "2007-01-01T00:00:00.000Z",
          "ended_at": "2016-12-05T00:00:00.000Z",
          "created_at": "2019-01-10T01:49:13.133Z",
          "updated_at": ""
        }
      ],
      "education": []
    },
    {
      "_id": "5b2c913440bc077d5786c339",
      "first_name": "Gideon",
      "last_name": "Gono",
      "name": "Gideon Gono",
      "age": "",
      "phone": "",
      "email": "",
      "gender": "Male",
      "nationality": "Zimbabwe",
      "country": "Zimbabwe",
      "region": "Africa",
      "city": "Harare",
      "linkedin": "",
      "created_at": "2018-06-22T06:03:32.854Z",
      "updated_at": "2018-06-22T06:04:33.423Z",
      "history": [
        {
          "active": false,
          "role": "job",
          "title": "Governor",
          "entity_id": "598cdaa60124e9fd2d05bce5",
          "started_at": "2003-01-01T00:00:00.000Z",
          "ended_at": "2013-01-01T00:00:00.000Z",
          "created_at": "2018-06-22T06:04:05.313Z",
          "updated_at": ""
        }
      ],
      "education": []
    }
  ],
  "total_items": 10
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.
status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "query_parameter": "sort_field",
          "message": "Value not in available options."
      }
  ],
  "status": 400
}

Retrieve one person

Retrieve one person.

Get/people/:_id

Path Parameters

_id
REQUIRED
TYPEstring
Get information about a specific person.
Get Person info
curl -v -X GET https://api.swfi.com/v1/people/:_id \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data._id
TYPEstring
Unique identifier for the person.
data.first_name
TYPEstring
First name of the person.
data.last_name
TYPEstring
Last name of the person. Field can be empty string.
data.name
TYPEstring
Concatenated first_name and last_name of the person. Field can be empty string.
data.age
TYPEnumber
Age of the person. Field can be an empty string.
data.phone
TYPEstring
Phone number for the contact. Field can be an empty string.
data.email
TYPEstring
The email address of the person. Field can be an empty string.
data.gender
TYPEstring
The gender of the person. Possible values: "Male" and "Female". Field can be an empty string.
data.nationality
TYPEstring
The nationality of the person. Field can be an empty string.
data.country
TYPEstring
The origin country of the person. Field can be an empty string.
data.region
TYPEstring
The origin country region of the person. Field can be an empty string.
data.city
TYPEstring
The city in which the person originated from. Field can be an empty string.
data.linkedin
TYPEstring
The LinkedIn® URL of the person. Field can be an empty string.
data.history
TYPEobject[]
The job and board history of the person. Field can be an empty list.
data.education
TYPEobject[]
The education history of the person. Field can be an empty list.
data.created_at
TYPEstring
The UTC time the person was created.
data.updated_at
TYPEstring
The UTC time the person was updated.
Example response
{
  "data": {
    "_id": "5b3173eea6e5a3f3b1ce4ec6",
    "first_name": "Geir",
    "last_name": "Nygård",
    "name": "Geir Nygård",
    "age": "",
    "phone": "",
    "email": "name@company.com",
    "gender": "Male",
    "nationality": "Norway",
    "country": "Norway",
    "region": "Europe",
    "city": "Oslo",
    "linkedin": "https://no.linkedin.com/in/geir-%C3%B8ivind-nyg%C3%A5rd",
    "created_at": "2018-06-25T23:01:32.588Z",
    "updated_at": "2022-01-12T18:14:50.539Z",
    "history": [
      {
        "active": true,
        "role": "job",
        "title": "Chief Asset Strategies Officer",
        "entity_id": "598cdaa60124e9fd2d05b9af",
        "started_at": "2020-09-07T00:00:00.000Z",
        "ended_at": "",
        "created_at": "2022-01-12T18:15:40.995Z",
        "updated_at": ""
      },
      {
        "active": false,
        "role": "job",
        "title": "Chief Investment Officer for Asset Strategies",
        "entity_id": "598cdaa60124e9fd2d05b9af",
        "started_at": "2016-12-01T00:00:00.000Z",
        "ended_at": "2020-08-05T00:00:00.000Z",
        "created_at": "2018-07-20T00:39:17.431Z",
        "updated_at": "2022-01-12T18:15:17.133Z"
      },
      {
        "active": false,
        "role": "job",
        "title": "Portfolio Manager in Equity Asset Strategies and other positions",
        "entity_id": "598cdaa60124e9fd2d05b9af",
        "started_at": "2007-01-01T00:00:00.000Z",
        "ended_at": "2016-12-05T00:00:00.000Z",
        "created_at": "2019-01-10T01:49:13.133Z",
        "updated_at": ""
      }
    ],
    "education": []
  }
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.
status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "path": "/v1/aum/:_id",
          "message": "Not Found"
      }
  ],
  "status": 404
}
News
core collectionReports
core collection
Documentation as of 10/19/2022