List Account Statuses

๐Ÿงพ List Account Statuses

Endpoint: GET /api/v3/accounts/statuses

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Retrieves all account statuses available in the system. Useful for displaying account lifecycle or filtering by status in UI components. You can optionally include inactive statuses or retrieve results in a specified language.


๐Ÿ” Query Parameters

Parameter Type Required Default Description
includeInactive boolean No false If true, includes inactive account statuses.
languageId integer No 1 ID of the language for localized status names.

๐Ÿ“ค Request Example

GET https://api.briefingedge.com/api/v3/accounts/statuses?includeInactive=false&languageId=1 Authorization: Bearer <token>  

โœ… Success Response (200 OK)

Returns an array of AccountStatus objects.

Each object typically includes fields like:

[  {    "StatusID": 1,    "Name": "Active",    "IsActive": true  },  {    "StatusID": 2,    "Name": "Inactive",    "IsActive": false  } ]  

โŒ Error Responses

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