Properties

Get Property Groups

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

limitinteger · min: 1 · max: 1000OptionalDefault: 1000

pageintegerOptionalDefault: 1

Responses

200Success

application/json

totalintegerOptionalExample: 50

get/properties/groups

GET /properties/groups HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "total": 50,
  "propertyGroups": [
    {
      "id": "cksq39rnv02vf0ns0t3o834uv",
      "name": "London South",
      "reference": "RB-Z0LMKJ",
      "customReference": null
    }
  ]
}

Get Properties

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

limitinteger · min: 1 · max: 1000OptionalDefault: 1000

pageintegerOptionalDefault: 1

propertystringOptional

Comma separated property IDs

Example: cksq4ybpq104zwgwh2gd1vvha

customreferencestringOptional

Comma separated property custom references

Example: CustomReference1,CustomReference2

Responses

200Success

application/json

totalintegerOptionalExample: 9250

get/properties

GET /properties HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "total": 9250,
  "properties": [
    {
      "id": "cksq4ybpq104zwgwh2gd1vvha",
      "name": "Demo Property",
      "reference": "RB-ABC123",
      "customReference": "MyUprn0001",
      "photoId": "cksq3jhl500ga0ls0oiibt7q2,",
      "address": {
        "line1": "33 Magnolia Avenue",
        "line2": "",
        "city": "London",
        "county": "",
        "postcode": "SW10 2BT"
      }
    }
  ]
}

Create Property

post

Triggers the property webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body

namestringRequired

parentstring · UID · nullableOptional

Parent property or property group ID. If null is provided, the property will be created in a property group called "Created by API"

customReferencestringOptional

skipWebhookbooleanOptionalDefault: false

Responses

200Success

application/json

idstring · UIDOptionalExample: yok0w80s0sckwwgo0c8sko4o

400Error

application/json

post/properties

POST /properties HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "parent": "u400ko8sk848gc40kss400sg",
  "name": "Building 1",
  "customReference": "B000001",
  "address": {
    "line1": "101 Wood Lane",
    "city": "London",
    "postcode": "W12 7FA"
  }
}

{
  "id": "yok0w80s0sckwwgo0c8sko4o"
}

Get Property Tree

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Responses

200Success

application/json

get/properties/tree

GET /properties/tree HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "tree": {
    "tree": [
      {
        "id": "cl8br0oe40001kkwhdglcu74r",
        "name": "Fox Residential",
        "type": "Organisation",
        "children": [
          {
            "id": "cl8br1p900001mgwhcpbhopcp",
            "name": "Manchester",
            "type": "Property Group",
            "children": [
              {
                "id": "cl8br4pnc0001opwhfidszqwt",
                "name": "Blonde Retreat",
                "type": "Property",
                "children": []
              },
              {
                "id": "cl8br4pph0003opwhouu2j0ew",
                "name": "The Blade Building",
                "type": "Property",
                "children": []
              }
            ]
          }
        ]
      }
    ]
  }
}

Update Property

patch

Update a property's name and address.

Triggers the property webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

propertyIdstring · UIDRequired

Body

namestringOptional

customReferencestringOptional

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/properties/{propertyId}

PATCH /properties/{propertyId} HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "parent": "u400ko8sk848gc40kss400sg",
  "name": "Building 1",
  "customReference": "B000001",
  "address": {
    "line1": "101 Wood Lane",
    "city": "London",
    "postcode": "W12 7FA"
  }
}

Move Property

patch

Move a property to a different position in the property tree; either below a property group or another property.

Triggers the property webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

propertyIdstring · UIDRequired

Body

parentstring · UIDRequired

Parent property or property group ID

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/properties/{propertyId}/parent

PATCH /properties/{propertyId}/parent HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "parent": "u400ko8sk848gc40kss400sg"
}

Get Property Team Users

get

Get a list of users responsible for teams for all properties in your organisation.

Responsible users are auto-assigned to tasks that are assigned to their team.
Users are automatically given access to properties they are responsible for.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

propertystring · UIDOptional

Comma separated property IDs

Example: cksq4ybpq104zwgwh2gd1vvha

userstring · UIDOptional

Comma separated user IDs

Example: cksq4xkxh012173wh9agrq0iz

includeinheritedbooleanOptional

Responsibility is inherited down the property tree. By default this endpoint will list responsbility which has been set explicitly. Set this to true to include inherited responsibility.

Default: falseExample: true

Responses

200Success

application/json

get/properties/teamusers

GET /properties/teamusers HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "properties": {
    "cksq4ofmx07arhowhtzzdqwxa": {
      "cksq5ee6p07fxedwh1pfowuxc": [
        "cksq4xga4078iwgwhn6dwvm2q"
      ],
      "cksq5ee5j0776edwhh347ruab": [
        "cksq4y6f700iswjwhhwdsb9mo",
        "cksq4xga4078iwgwhn6dwvm2q",
        "cksq5ev5f00ylw9whbmkwku7z"
      ]
    },
    "cksq4p0aa070mhowhbw5gomri": {
      "cksq5ee6p07fxedwh1pfowuxc": [
        "cksq4xga4078iwgwhn6dwvm2q"
      ]
    }
  }
}

Add Property Team Users

patch

Set which users are responsible for teams at this property.

Users are added as members of the team if they aren't already. Triggers the team webhook if users are added to the team.
Invalid user IDs are silently ignored.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

propertyIdstring · UIDRequired

Body

teamstring · UIDRequired

usersstring · UID[]Required

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/properties/{propertyId}/teamusers/add

PATCH /properties/{propertyId}/teamusers/add HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "team": "cksq5ee6607bwedwhkb6ra827",
  "users": [
    "cksq50h7g0638hywhasfzw7cd"
  ]
}

Remove Property Team Users

patch

Remove users as responsible for teams at this property.

Users are unassigned from any tasks they were auto-assigned to.
Invalid user IDs are silently ignored.
Users are not removed as members of the team.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

propertyIdstring · UIDRequired

Body

teamstring · UIDRequired

usersstring · UID[]Required

Responses

204Success

400Error

application/json

patch/properties/{propertyId}/teamusers/remove

PATCH /properties/{propertyId}/teamusers/remove HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "team": "cksq5ee6607bwedwhkb6ra827",
  "users": [
    "cksq50h7g0638hywhasfzw7cd"
  ]
}

PreviousUsers & Teams NextProperty Assets

Last updated 1 month ago

Was this helpful?