List Persons

๐Ÿงพ List Persons

Endpoint: GET /api/v3/persons

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Retrieves a paginated list of internal persons from the system. This endpoint is commonly used to search, filter, and display user records for internal roles such as coordinators, presenters, and contributors.


๐Ÿ” Query Parameters

Parameter Type Required Default Description
active boolean No โ€” If provided, filters by active status.
page integer No 1 Page number for pagination.
pageSize integer No 25 Number of records per page.

๐Ÿ“ค Request Example

GET https://api.briefingedge.com/api/v3/persons?page=1&pageSize=25&active=true Authorization: Bearer <token>  

โœ… Success Response (200 OK)

Returns a paginated list of Person objects with metadata.

Example:

{  "Records": [    {      "PersonID": 1,      "FirstName": "Alex",      "LastName": "Matthews",      "Email": "amatthews@example.com",      "IsActive": true    },    {      "PersonID": 2,      "FirstName": "Jamie",      "LastName": "Lee",      "Email": "jlee@example.com",      "IsActive": true    }  ],  "Metadata": {    "Page": 1,    "PageSize": 25,    "Total": 100  } }  

โŒ Error Responses

Code Message Description
401 Unauthorized Missing or invalid bearer token.
500 Internal Server Error Unexpected server-side failure.