Skip to main content

Get a business beneficial

GET /api/v1/BusinessesBeneficials/:id/get

Description​

This endpoint allows the retrieval of details of a specific business beneficial.

Request​

-Path

/api/v{version}/BusinessesBeneficials/{id}/get

Headers​

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

Path Parameters​

  • id: Business beneficial ID.

  • version: API version.

Response​

Success (200)​
jsonCopy code{
  "schema": {
    "$ref": "#/components/schemas/GetBusinessBeneficialResponseResponse"
  }
}

/api/v1/BusinessesBeneficials/:id/get

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Accepttext/plain

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "isSignee": `<boolean>`,
    "personId": `<uuid>`,
    "businessId": `<uuid>`,
    "votingShare": `<float>`,
    "relationshipToBusiness": 1
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/BusinessesBeneficials/:id/get \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!