The PUBLIC API always returns JSON formatted data. By default, we will return data for 2 levels of the object hierarchy. This should be enough for most applications but sometimes you may need additional levels and a deeper object graph.
{
"Level1": {
"Level2": {
"Level3": {
}
}
}
In these cases, you can use the?_depth parameter to request a specific number of levels.
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=Business&_depth=1
{
"Name": "Kalkio Space - East Side",
"WebAddress": "kalkiospace",
"Address": "1-3 Brixton Road, \r\nSW9 6DE\r\nLondon",
"Phone": null,
"Fax": null,
"EmailContact": null,
"WebContact": null,
"CookiePolicyUrl": null,
"PrivacyPolicyUrl": null,
"Quote": null,
"NativeHomeUrl": "https://kalkiospace.spaces.nexudus.com",
"NativeHomeUrlWithLanguage": "https://kalkiospace.spaces.nexudus.com/en",
"HomeUrl": "https://kalkiospace.spaces.nexudus.com",
"HomeUrlWithLanguage": "https://kalkiospace.spaces.nexudus.com/en",
"TransactionFee": 1,
"Country": {},
"Currency": {},
"SimpleTimeZone": {},
"Businesses": [],
"AboutUs": null,
"ShortIntroduction": null,
"BillingName": "Kalkio Space",
"BillingAddress": "1-3 Brixton Road",
"BillingCity": "London",
"BillingPostCode": "SW9 6DE",
"BillingBankName": "",
"BillingAccountCode": "",
"BillingSortCode": "",
"TermsAndConditions": "Terms",
"Longitude": 0,
"Latitude": 0,
"IsChildLocation": true,
"HasLogo": true,
"HasBanner": true,
"Id": 1004930927,
"IdString": "1004930927",
"UpdatedOn": "2020-06-07T15:06:36",
"CreatedOn": "2019-04-28T17:23:25",
"UniqueId": "a596d492-5f26-4645-a971-600ccf9a61e2",
"IsNull": false
}
Important
Use this with caution as additional levels of data will require additional processing and more data, which will basically degrade performance and make your requests hit the rate limits quicker.
Common data
The following data is available in all API endpoints in the Public API but we typically recommend to use the root endpoint (/en).
User and Coworker (your customer) data will only be available if you are passing valid authentication data.
Location data
Gets data about this location.
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=Business&_depth=2
{
"Name": "Kalkio Space - East Side",
"WebAddress": "kalkiospace",
"Address": "1-3 Brixton Road, \r\nSW9 6DE\r\nLondon",
"Phone": null,
"Fax": null,
"EmailContact": null,
"WebContact": null,
"CookiePolicyUrl": null,
"PrivacyPolicyUrl": null,
"Quote": null,
"NativeHomeUrl": "https://kalkiospace.spaces.nexudus.com",
"NativeHomeUrlWithLanguage": "https://kalkiospace.spaces.nexudus.com/en",
"HomeUrl": "https://kalkiospace.spaces.nexudus.com",
"HomeUrlWithLanguage": "https://kalkiospace.spaces.nexudus.com/en",
"TransactionFee": 1,
"Country": {
"Name": "United States",
"Id": 1221,
"IdString": "1221",
"UpdatedOn": "2012-01-23T14:35:50",
"CreatedOn": "2012-01-23T14:35:50",
"UniqueId": "e5ea470a-1440-4b37-ac9c-1949b6a70830",
"IsNull": false
},
"Currency": {
"Name": "US Dollar (USD)",
"Code": "USD",
"Format": "$0.00",
"Id": 3004,
"IdString": "3004",
"UpdatedOn": "2013-05-25T14:49:16",
"CreatedOn": "2012-01-23T14:35:50",
"UniqueId": "29fe8a0f-fb71-4b42-a3eb-c2f29cfcd8e2",
"IsNull": false
},
"SimpleTimeZone": {
"Name": "GMT Standard Time",
"Iana": "Europe/London",
"TimeOffset": "0",
"UsesSummerTime": true,
"OffsetInMinutes": 60,
"Id": 2023,
"IdString": "2023",
"UpdatedOn": "2013-05-11T14:51:22",
"CreatedOn": "2012-01-23T14:35:50",
"UniqueId": "12d47167-0964-42e8-aab6-e58f441ae9b3",
"IsNull": false
},
"Businesses": [],
"AboutUs": null,
"ShortIntroduction": null,
"BillingName": "Kalkio Space",
"BillingAddress": "1-3 Brixton Road",
"BillingCity": "London",
"BillingPostCode": "SW9 6DE",
"BillingBankName": "",
"BillingAccountCode": "",
"BillingSortCode": "",
"TermsAndConditions": "Terms",
"Longitude": 0,
"Latitude": 0,
"IsChildLocation": true,
"HasLogo": true,
"HasBanner": true,
"Id": 1004930927,
"IdString": "1004930927",
"UpdatedOn": "2020-06-07T15:06:36",
"CreatedOn": "2019-04-28T17:23:25",
"UniqueId": "a596d492-5f26-4645-a971-600ccf9a61e2",
"IsNull": false
}
User data
Gets data about the logged in user
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=User&_depth=2
{
"FullName": "John Doe",
"Email": "[email protected]",
"AccessToken": "eyJhbGciOiJIUzI....",
"Devices": null,
"CanAccessPlatform": true,
"CoworkerId": 1066293228,
"OnHelpDeskMsg": true,
"OnNewWallPost": false,
"OnNewBlogComment": true,
"OnNewEventComment": true,
"ReceiveCommunityDigest": true,
"ReceiveEveryMessage": true,
"IsAuthenticated": true,
"Id": 1219850439,
"IdString": "1219850439",
"UpdatedOn": "2021-10-21T08:06:29",
"CreatedOn": "2019-12-18T21:26:29",
"UniqueId": "123f132d-fefb-4284-a8b6-db54485ae6c6",
"IsNull": false
}
Customer data
Gets data about the logged in customer
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=Coworker&_depth=2
{
"FullName": "John Doe",
"GuessedFirstNameForInvoice": "David",
"GuessedLastNameForInvoice": "Smith",
"GuessedFirstName": "John",
"GuessedLastName": "Doe",
"Salutation": "John",
"Address": "1-3 Brixton Road",
"PostCode": "SW165DE",
"CityName": "London",
"State": "London",
"Email": "[email protected]",
"Active": true,
"DiscountCode": null,
"RefererGuid": "",
"ReferenceNumber": null,
"HasZoom": true,
"HasOffice365": true,
"HasGoogle": false,
"IsNew": false,
"CheckedIn": false,
"SignUpToNewsletter": false,
"DeleteAvatar": false,
"DeleteBanner": false,
"AllowNetworkCheckin": true,
"CanMakeBookings": true,
"CanPurchaseProducts": true,
"CanPurchaseEvents": true,
"CanAccessCommunity": true,
"AccessCardId": null,
"AvatarUrl": "/en/coworker/getavatar/1066293228",
"ProfileUrl": "/en/directory/profile/1066293228/john-doe",
"CountryId": 1220,
"BillingCountryId": 1220,
"InvoicingSpaceId": 1004930927,
"InvoicingSpaceGuid": "a596d492-5f26-4645-a971-600ccf9a61e2",
"InvoicingSpaceName": "Kalkio Space - East Side",
"HomeSpaceId": 1004930927,
"InvoicingBusinessId": 1004930927,
"HomeSpaceGuid": "a596d492-5f26-4645-a971-600ccf9a61e2",
"HomeSpaceName": "Kalkio Space - East Side",
"SimpleTimeZoneId": 2023,
"IsMember": false,
"CancellationDate": null,
"UtcCancellationDate": null,
"AbsoluteCancellationDate": null,
"TariffNames": null,
"TariffIds": null,
"TeamNames": null,
"PaysForTeamUniqueId": null,
"IsPayingMember": false,
"IsPaidForCustomer": false,
"IsTeamAdministrator": false,
"DoNotProcessInvoicesAutomatically": false,
"MobilePhone": "07765552825",
"LandLine": "07765552825",
"NickName": null,
"BusinessArea": null,
"Position": null,
"CompanyName": null,
"ProfileTags": "3d printing",
"ProfileTagsSpaces": "3d printing",
"ProfileTagsList": [
"3d printing"
],
"ProfileSummary": "asdasdasd",
"ProfileSummaryHtml": "<p>asdasdasd</p>\n",
"ProfileWebsite": null,
"Url": "http://kalkiospace.spaces.nexudus.com/Public/Directory/Profile/1066293228/john-doe/",
"Gender": "Male",
"ProfileIsPublic": true,
"RegistrationDate": "2019-06-15T15:37:50",
"UtcRegistrationDate": "2019-06-15T14:37:50",
"DateOfBirth": "1981-07-03T00:00:00",
"UtcDateOfBirth": "1981-07-02T23:00:00",
"Twitter": null,
"Skype": null,
"Facebook": null,
"Linkedin": null,
"Google": null,
"Telegram": null,
"Github": null,
"Pinterest": null,
"Flickr": null,
"Instagram": null,
"Vimeo": null,
"Tumblr": "https://[email protected]",
"Blogger": null,
"HasContactDetails": false,
"BillingName": "David Smith",
"BillingEmail": "[email protected]",
"BillingAddress": "1-3 Brixton Road, SW165DE",
"BillingPostCode": "SW96DE",
"BillingCityName": "London",
"BillingState": "London",
"TaxIDNumber": null,
"CardNumber": null,
"AccessPincode": "87842",
"Custom1": "Facebook",
"Custom2": "Construction",
"Custom3": null,
"Custom4": "true",
"Custom5": null,
"Custom6": null,
"Custom7": null,
"Custom8": null,
"Custom9": null,
"Custom10": null,
"Custom11": null,
"Custom12": null,
"Custom13": null,
"Custom14": null,
"Custom15": null,
"Custom16": null,
"Custom17": null,
"Custom18": null,
"Custom19": null,
"Custom20": null,
"Custom21": null,
"Custom22": null,
"Custom23": null,
"Custom24": null,
"Custom25": null,
"Custom26": null,
"Custom27": null,
"Custom28": null,
"Custom29": null,
"Custom30": null,
"EnableGoCardlessPayments": false,
"StripeDirectDebitPaymentsEnabled": true,
"GoCardlessContractNumber": null,
"HasGoCardlessContractNumber": false,
"HasStripeDirectDebitMandate": false,
"HasStripeACHCustomerToken": false,
"HasStripeACHBankToken": false,
"HasSetupRegularPayments": true,
"RegularPaymentProvider": "MultiGateway",
"RegularPaymentContractNumber": "TgMFVgoO2lPm4hvNjlrTr5m6tpv",
"HasRegularPaymentContractNumber": true,
"HasAcceptedStripeACHAgreement": false,
"HasVerifiedStripeACHDeposits": false,
"StripePublicKeKey": "pk_live_UjVZbD8VkDxDpniMANnOxXNq",
"EmailForInvoice": "[email protected]",
"AddressForInvoice": "1-3 Brixton Road, SW165DE",
"PostCodeForInvoice": "SW96DE",
"CityForInvoice": "London",
"StateForInvoice": "London",
"FullNameForInvoice": "David Smith",
"GeneralTermsAccepted": true,
"GeneralTermsAcceptedOnline": true,
"AgeInDays": 858.72869367778821,
"HasBanner": true,
"Id": 1066293228,
"IdString": "1066293228",
"UpdatedOn": "2021-10-20T19:04:03",
"CreatedOn": "2019-06-15T14:37:50",
"UniqueId": "42728d03-c1cc-465b-9092-0febc44b74f1",
"IsNull": false
}
ResourceGroups and Resources
Gets data about the published resources and their groups
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=Resources&_depth=2
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=ResourceGRoups&_depth=2
Languages data
Gets data the languages available for this location
GET https://{defaultBusinessWebAddress}.spaces.nexudus.com/en?_resource=Languages&_depth=2
[
{
"Name": "English",
"Culture": "en",
"IsRtl": false,
"Id": 1004932929,
"IdString": "1004932929",
"UpdatedOn": "2019-04-28T17:23:29",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "5b1341a2-b888-4c3e-8ae7-e5e9ede4e590",
"IsNull": false
},
{
"Name": "Español",
"Culture": "es",
"IsRtl": false,
"Id": 1004932930,
"IdString": "1004932930",
"UpdatedOn": "2019-04-28T17:23:29",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "9ef70f01-9990-47c8-b773-320af51eaa86",
"IsNull": false
},
{
"Name": "Italiano",
"Culture": "it",
"IsRtl": false,
"Id": 1004932931,
"IdString": "1004932931",
"UpdatedOn": "2019-04-28T17:23:29",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "8c838a6c-f89e-4f20-81c2-7b5f40e06a6e",
"IsNull": false
},
{
"Name": "Português",
"Culture": "pt",
"IsRtl": false,
"Id": 1004932932,
"IdString": "1004932932",
"UpdatedOn": "2019-04-28T17:23:29",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "58193519-9bfb-4f0c-87f9-078677531f41",
"IsNull": false
},
{
"Name": "German",
"Culture": "de",
"IsRtl": false,
"Id": 1004932933,
"IdString": "1004932933",
"UpdatedOn": "2021-10-20T17:41:59",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "e2703140-7ab4-49fa-9310-c292520dce6b",
"IsNull": false
},
{
"Name": "French",
"Culture": "fr",
"IsRtl": false,
"Id": 1004932934,
"IdString": "1004932934",
"UpdatedOn": "2019-04-28T17:23:29",
"CreatedOn": "2019-04-28T17:23:29",
"UniqueId": "af4b6bcc-6e73-417c-ad8c-53c2d4c87fd5",
"IsNull": false
},
{
"Name": "Polish",
"Culture": "pl",
"IsRtl": false,
"Id": 1376761386,
"IdString": "1376761386",
"UpdatedOn": "2020-08-28T18:45:35",
"CreatedOn": "2020-08-28T18:45:35",
"UniqueId": "406bea10-2e8f-4c7d-9605-8b7af7d445a8",
"IsNull": false
},
{
"Name": "Japanese",
"Culture": "ja",
"IsRtl": false,
"Id": 1414894664,
"IdString": "1414894664",
"UpdatedOn": "2021-06-08T19:25:56",
"CreatedOn": "2021-06-08T19:25:56",
"UniqueId": "471a82dc-b486-47c7-8417-715206a4deb3",
"IsNull": false
},
{
"Name": "Arabic",
"Culture": "ar",
"IsRtl": true,
"Id": 1414894759,
"IdString": "1414894759",
"UpdatedOn": "2021-10-20T17:33:09",
"CreatedOn": "2021-06-08T19:26:32",
"UniqueId": "3de6be0c-d948-4193-ae77-120ea00e3beb",
"IsNull": false
}
]