--- title: "V2: Person (Get)" description: "V2: Person (Get)" --- [Skip to content](https://nexusengage.com/help/v2-person-get#main-content) English Show submenu for translations ![fb2acfcb-b621-467c-ac7f-d5d4beee378d-1](https://nexusengage.com/hs-fs/hubfs/fb2acfcb-b621-467c-ac7f-d5d4beee378d-1.png?width=200&height=53&name=fb2acfcb-b621-467c-ac7f-d5d4beee378d-1.png) Open main navigation Close main navigation - English Show submenu for translations - [Nexus Website](https://nexuscenter.io/) [Nexus Website](https://nexuscenter.io/) What are you looking for? - There are no suggestions because the search field is empty. 1. [Nexus Help Center](https://nexusengage.com/help) 2. [Engagement Hub](https://nexusengage.com/help/engagement-hub) 3. [API](https://nexusengage.com/help/engagement-hub#api) # V2: Person (Get) ### **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/personsGET /api/v2/persons?offset=0&limit=20GET /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} ``` ### URL ``` https://w17.briefingedge.com/BEAPIREST/api/v2/persons/{id} ``` ### HTTP Method `get` ### Description Retrieves a single person’s full profile by their 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": "Alex Matthews is ", "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. - [Engagement Hub](https://nexusengage.com/help/engagement-hub#main-content) - [Release Notes](https://nexusengage.com/help/engagement-hub#release-notes) - [Dashboard and Calendar](https://nexusengage.com/help/engagement-hub#dashboard-and-calendar) - [Visit Requests and Form](https://nexusengage.com/help/engagement-hub#visit-requests-and-form) - [Visit Scheduling and Management](https://nexusengage.com/help/engagement-hub#visit-scheduling-and-management) - [Site and Room Administration](https://nexusengage.com/help/engagement-hub#site-and-room-administration) - [User Management and Profiles](https://nexusengage.com/help/engagement-hub#user-management-and-profiles) - [System Configurations](https://nexusengage.com/help/engagement-hub#system-configurations) - [API](https://nexusengage.com/help/engagement-hub#api) - [Domain](https://nexusengage.com/help/engagement-hub#domain) - [Topics/Agenda](https://nexusengage.com/help/engagement-hub#topics-agenda) - [Global Settings](https://nexusengage.com/help/engagement-hub#global-settings) - [Visit Types](https://nexusengage.com/help/engagement-hub#visit-types) - [Admin](https://nexusengage.com/help/engagement-hub#admin) - [Communication](https://nexusengage.com/help/engagement-hub#communication) - [Visit Management](https://nexusengage.com/help/engagement-hub#visit-management) - [Artificial Intelligence (AI)](https://nexusengage.com/help/engagement-hub#artificial-intelligence-ai) - [Availability](https://nexusengage.com/help/engagement-hub#availability) - [Visit List](https://nexusengage.com/help/engagement-hub#visit-list) - [Export](https://nexusengage.com/help/engagement-hub#export) - [Requestor](https://nexusengage.com/help/engagement-hub#requestor) - [FAQ](https://nexusengage.com/help/engagement-hub#faq) - [Login Access](https://nexusengage.com/help/engagement-hub#login-access) - [Coordinator](https://nexusengage.com/help/engagement-hub#coordinator) - [Visit Status](https://nexusengage.com/help/engagement-hub#visit-status) - [Individual Time Block](https://nexusengage.com/help/engagement-hub#individual-time-block) - [Navigation](https://nexusengage.com/help/engagement-hub#navigation) - [Itinerary](https://nexusengage.com/help/engagement-hub#itinerary) - [Invitation](https://nexusengage.com/help/engagement-hub#invitation) - [Speakers](https://nexusengage.com/help/engagement-hub#speakers) - [Off-Site](https://nexusengage.com/help/engagement-hub#off-site) - [Survey](https://nexusengage.com/help/engagement-hub#survey) - [Attendee](https://nexusengage.com/help/engagement-hub#attendee) - [Sales Enablement Hub](https://nexusengage.com/help/sales-enablement-hub#main-content) - [Dynamics Application](https://nexusengage.com/help/sales-enablement-hub#dynamics-application) - [Salesforce Application](https://nexusengage.com/help/sales-enablement-hub#salesforce-application) - [Release Notes](https://nexusengage.com/help/sales-enablement-hub#release-notes) - [Experience Hub](https://nexusengage.com/help/experience-hub#main-content) - [Customer Portal](https://nexusengage.com/help/experience-hub#customer-portal) - [Onsite Channels](https://nexusengage.com/help/experience-hub#onsite-channels) - [Program Site](https://nexusengage.com/help/experience-hub#program-site) - [Content Management](https://nexusengage.com/help/experience-hub#content-management) - [Analytics](https://nexusengage.com/help/experience-hub#analytics) - [Nexus Experience Hub Single Sign On](https://nexusengage.com/help/experience-hub#nexus-experience-hub-single-sign-on) - [Content Chapters](https://nexusengage.com/help/experience-hub#content-chapters) - [Door Monitor](https://nexusengage.com/help/experience-hub#door-monitor) - [Media](https://nexusengage.com/help/experience-hub#media) - [Home Screen](https://nexusengage.com/help/experience-hub#home-screen) [![Nexus-Logo](https://nexusengage.com/hs-fs/hubfs/Nexus-Logo.jpg?width=143&height=50&name=Nexus-Logo.jpg "Nexus-Logo")](http://www.signet.tv) Nexus Help Center  Contact Nexus Support: [support@nexuscenter.io](mailto:support@nexuscenter.io)  Copyright © 2025, Nexus ```json { "@context" : "https://schema.org", "@id" : "https://nexusengage.com/#organization", "@type" : "Organization", "description" : "AI-powered customer engagement platform for enterprise teams.", "knowsAbout" : [ "Customer Engagement", "Briefing Programs", "Customer Experience", "Sales Enablement", "Executive Briefings", "Customer Advocacy" ], "logo" : { "@type" : "ImageObject", "height" : 32, "url" : "https://nexusengage.com/hubfs/raw_assets/public/nexus-theme/images/theme/nexus-logo.svg", "width" : 160 }, "name" : "Nexus", "sameAs" : [ "https://www.linkedin.com/company/nexus-hub/" ], "url" : "https://nexusengage.com" } ``` ```json { "@context" : "https://schema.org", "@id" : "https://nexusengage.com/#website", "@type" : "WebSite", "inLanguage" : "en", "name" : "Nexus", "publisher" : { "@id" : "https://nexusengage.com/#organization" }, "url" : "https://nexusengage.com" } ```