Search Persons

🧾 Search Persons

Endpoint: POST /api/v3/persons/search

Auth Required: ✅ Yes (Bearer Token)

📝 Description

Performs a filtered search to retrieve persons matching specific criteria such as name, email, or other attributes. Useful for dynamic search interfaces, form lookups, and filtered person listings.

🔍 Query Parameters

None.

📥 Request Body

Content-Type: application/json

Include a filters object along with pagination parameters.

🔧 Sample Schema

{  "filters": {    "<field>": "<value>"  },  "page": 1,  "pageSize": 25 }  

📤 Request Example

POST https://api.briefingedge.com/api/v3/persons/search Authorization: Bearer <token> Content-Type: application/json  {  "filters": {    "email": "jane.doe@example.com"  },  "page": 1,  "pageSize": 25 }  

✅ Success Response (200 OK)

Returns an array of Person objects matching the filter criteria, along with pagination metadata.

Example:

{  "Records": [    {      "PersonID": 4321,      "FirstName": "Jane",      "LastName": "Doe",      "Email": "jane.doe@example.com",      "IsActive": true    }  ],  "Metadata": {    "Page": 1,    "PageSize": 25,    "Total": 1  } }  

❌ Error Responses