Read Account by ID
Endpoint
GET /api/v3/accounts/{accountId}
Description
Retrieves details for a single account. This endpoint allows you to fetch account-specific information by providing its unique ID.
Authentication Required: Yes — Bearer Token
URL Parameters
Name | Type | Required | Description |
---|---|---|---|
accountId |
integer/string | Yes | The unique identifier of the account. |
Query Parameters
Name | Type | Required | Default | Description |
---|---|---|---|---|
includeInactive |
boolean | No | false | Whether to include inactive related data (if supported). |
languageId |
integer | No | 1 | Language ID for localized fields. |
Request Body
This endpoint does not accept a request body.
Example Request
GET https://api.briefingedge.com/api/v3/accounts/12345?languageId=1 Authorization: Bearer <token>
Success Response
Code: 200 OK
Content: Returns the account object.
Error Responses
Code | Message |
---|---|
401 | Unauthorized |
404 | Not Found |
500 | Internal Server Error |