Gets Scheme engagement based on url

get https://{tenant}.rubixx.app/api/v2/supportschemes/{supportSchemeReference}/engagements/{engagementReference}

Sample Request:

GET /api/v2.0/supportschemes/SP1000000004/engagements/SE1000000000

Sample Response:

  {
      "engagementId": "34917041-309f-4dc6-51be-08dc3ac7cd66",
      "schemeName": "St Paul's",
      "schemereference": "SP0000000004",
      "engagementReference": "SE1000000000",
      "engagementOwner": null,
      "personName": "Joseph Smith",
      "status": "Ended",
      "occupancyReference": null,
      "address": "The Old Queen's Head, 4 Main St, Witton Park, DL14 0DY",
      "startDate": "02/03/2024",
      "endDate": null,
      "safeToTalkWord": null,
      "notSafeToTalkWord": null            
  }

Required Permission(s): SupportPlans.View

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://.rubixx.app/api/v2/supportschemes/supportSchemeReference/engagements/engagementReference \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200On Success

400If the request is malformed or incorrect

401If the supplied token is not correct

403If the provided bearer token cannot perform the current request due to a lack of permissions

404If the requested resource cannot be found

500An internal server error