← Shares API

GET/v2/shares?externalId={externalId}Get Share

Get share by external id.
parameterexternalId{externalId}
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
status404User/user group/organization/device/device group not found
[{
"id" : Number,
"organization" : {
"id" : Number,
"name" : String,
"personal" : Boolean
},
"creatorAccount" : {
"id" : Number,
"firstName" : String,
"lastName" : String
},
"startDate" : Local date (ISO 8601, e.g. "2022-06-23"),
"startTime" : Local time (ISO 8601, e.g. "13:53:02"),
"endDate" : Local date (ISO 8601, e.g. "2022-06-23"),
"endTime" : Local time (ISO 8601, e.g. "13:53:02"),
"schedule" : [{
"dayOfWeek" : "Monday" / "Tuesday" / "Wednesday" / "Thursday" / "Friday" / "Saturday" / "Sunday",
"period" : {
"startTime" : Local time (ISO 8601, e.g. "13:53:02"),
"endTime" : Local time (ISO 8601, e.g. "13:53:02")
},
"recurrence" : "Daily" / "Weekly" / "BiWeekly"
}],
"permissions" : {
"administrate" : Boolean,
"remoteActivate" : Boolean,
"assignKeyfob" : Boolean
},
"source" : {
"device" : {
"id" : Number,
"name" : String,
"location" : String,
"remarks" : String,
"carouselImageUrl" : String
},
"deviceGroup" : {
"id" : Number,
"name" : String,
"remarks" : String,
"location" : String
}
},
"receiver" : {
"user" : {
"id" : Number,
"firstName" : String,
"lastName" : String,
"emailAddress" : String,
"emailAddressVerify" : Boolean,
"emailAddressVerified" : Boolean,
"phoneNumber" : Phone number (E.164, e.g. "+31850607337"),
"phoneNumberVerify" : Boolean,
"phoneNumberVerified" : Boolean,
"registered" : Boolean,
"account" : {
"id" : Number,
"firstName" : String,
"lastName" : String,
"emailAddress" : String,
"phoneNumber" : Phone number (E.164, e.g. "+31850607337")
},
"invitation" : {
"token" : String, UUID 4 formatted (e.g. "a426e157-8a5c-456a-8865-bec6394867ab"),
"url" : String,
"expiration" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"isExpired" : Boolean
}
},
"userGroup" : {
"id" : Number,
"name" : String
}
},
"personalSettings" : {
"notifications" : Boolean
},
"autoRemoveAfter" : "WEEK" / "MONTH" / "YEAR",
"autoRemoveDate" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateValidated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateRestricted" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"webKey" : String,
"externalId" : String
}]

Example: Get a specific share by externalId

GET/v2/shares

parameterexternalIdexternalId
headerAuthorizationBearer 16fbdd0d-7392-4568-8b9b-0f5a6ca4862c

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
[{
"id": 2,
"organization": {
"id": 2,
"name": "WebKeyOrg",
"personal": false
},
"creatorAccount": {
"id": 3
},
"startDate": "2026-03-10",
"startTime": "09:35:38",
"endDate": "2026-03-15",
"endTime": "09:35:38",
"permissions": {
"administrate": false,
"remoteActivate": true,
"assignKeyfob": false
},
"source": {
"device": {
"id": 2,
"name": "Lock",
"location": "Bold Office",
"remarks": "Remarks",
"carouselImageUrl": "https://resources.boldsmartlock.com/carousel-device-images/door_1.jpg"
}
},
"receiver": {
"user": {
"id": 4,
"emailAddressVerify": false,
"emailAddressVerified": false,
"phoneNumber": "+40711111301",
"phoneNumberVerify": false,
"phoneNumberVerified": false,
"registered": true,
"account": {
"id": 4,
"emailAddress": "webkey@example.com",
"phoneNumber": "+40711111301"
}
}
},
"personalSettings": {
"notifications": false
},
"dateCreated": "2026-03-10T09:33:38.112874Z",
"externalId": "externalId"
}]