Get Account Options

Endpoint

GET /api/v3/accounts/options


Description

Retrieves option lists related to accounts, filtered by a specified option type. Useful for populating dropdowns or validating account-related fields.

Authentication Required: Yes — Bearer Token


URL Parameters

This endpoint does not use URL parameters.


Query Parameters

Name Type Required Default Description
optionType string Yes The category/type of options to retrieve.
includeInactive boolean No false Whether to include inactive options.
languageId integer No 1 Language ID for localized content.

Request Body

This endpoint does not accept a request body.


Example Request

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

Success Response

Code: 200 OK

Content: An array of option items.

Example:

[  {    "OptionId": 1,    "OptionName": "Technology",    "IsActive": true  },  {    "OptionId": 2,    "OptionName": "Healthcare",    "IsActive": true  } ]  

Error Responses

Code Message
400 Bad Request
401 Unauthorized
500 Internal Server Error