Get Persons

Overview

The Persons APIs allow retrieval of individual and bulk person records within the Nexus Engagement Hub. These endpoints allow developers to fetch contact details, including basic person info and profile metadata. Useful for bulk retrieval of person records in the process of syncing users between systems.

It targets internal person records only (not external contacts).

HTTP Method

get

Endpoint:

/api/v2/persons

URL

https://w17.briefingedge.com/BEAPIREST/api/v2/persons

Description

Retrieves a paginated list of all internal persons in the system.

Query Parameters

Parameter Type Required Description
offset int No Number of records to skip. Default: 0
limit int No Number of records to return. Default: 100 , Max recommended: 100
isactive bool No Filtering by the “IsActive” field.

Example Request

GET /api/v2/persons
GET /api/v2/persons?offset=0&limit=20
GET /api/v2/persons?offset=5&limit=10&isactive=true

Example Response

{
  "Records": [
    {
            "ID": 13,
            "FirstName": "Tommy",
            "LastName": "Matthews",
            "NameOnID": null,
            "Prefix": null,
            "Suffix": null,
            "Gender": null,
            "Email": "twmatthews@yahoo.com",
            "JobTitle": "Account Executive",
            "DateOfBirth": null,
            "Phone1": "111-111-4715",
            "Phone2": "111-111-5555",
            "Address": null,
            "City": null,
            "StateProvince": null,
            "PostalCode": null,
            "Country": null,
            "CompanyName": null,
            "CorporateID": "",
            "HomeSiteID": "5",
            "UserRole": null,
            "Biography": null,
            "ProfilePicture": null,
            "ProfilePictureUrl": null,
            "ProfilePicturePreviewUrl": null,
            "IsActive": "true",
            "IsUser": "false",
            "IsSpeaker": "false",
            "IsExternal": "false"
    },
    {
     ............................
    }
  ],
  "Metadata": {
    "Limit": 20,
    "Offset": 0,
    "Total": 245,
    "Links": {
      "Self": "...",
      "Next": "...",
      "First": "...",
      "Last": "..."
    }
  }
}

Endpoint:

/api/v2/persons/{id}

Description

Retrieves a single person’s full profile by their ID.

URL

https://w17.briefingedge.com/BEAPIREST/api/v2/persons/{id}

URL Parameters

Parameter Type Required Description
id int Yes Unique ID of the person

Example Request

GET /api/v2/persons/17

Example Response

{
    "ID": 17,
    "FirstName": "Alex",
    "LastName": "Matthews",
    "NameOnID": null,
    "Prefix": null,
    "Suffix": null,
    "Gender": null,
    "Email": "am@nexus.io",
    "JobTitle": "Customer Experience Director",
    "DateOfBirth": null,
    "Phone1": "999-888-7766",
    "Phone2": "333-444-5566",
    "Address": null,
    "City": null,
    "StateProvince": null,
    "PostalCode": null,
    "Country": null,
    "CompanyName": null,
    "CorporateID": null,
    "HomeSiteID": "5",
    "UserRole": null,
    "Biography": "<div">Alex Matthews is </div>",
    "ProfilePicture": null,
    "ProfilePictureUrl": "https://cdn-c....",
    "ProfilePicturePreviewUrl": "https://cdn-c...",
    "IsActive": "true",
    "IsUser": "false",
    "IsSpeaker": "true",
    "IsExternal": "false"
}

Notes

  • Fields such as Biography may include HTML-formatted text.
  • Profile image fields may be null if no image is available.
  • IsUser , IsSpeaker , and IsExternal are stringified boolean flags ("true" or "false" ).
  • Use Metadata.Links for pagination in list responses.