Reference

Coworker

The coworker object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworker
AccessCardId: string optional
AccessPincode: string optional
Active: bool optional
Address: string optional
AlertNote: string optional
AllowNetworkCheckin: bool optional
BankAccount: string optional
BankBranch: string optional
BankName: string optional
BillingAddress: string optional
BillingCityName: string optional
BillingCountryId: Id optional
BillingEmail: string optional
BillingName: string optional
BillingPostCode: string optional
BillingSimpleTimeZoneId: Id optional
BillingState: string optional
Blogger: string optional
BusinessArea: string optional
CanAccessCommunity: bool optional
CanMakeBookings: bool optional
CanPurchaseEvents: bool optional
CanPurchaseProducts: bool optional
CardNumber: string optional read-only
CheckinSinceLastRenewal: int required read-only
CityName: string optional
CompanyName: string optional
CountryId: Id required
CoworkerType: Nexudus.Coworking.Core.Enums.eCoworkerRecordType optional
CreateUser: bool optional
Custom1: string optional
Custom10: string optional
Custom11: string optional
Custom12: string optional
Custom13: string optional
Custom14: string optional
Custom15: string optional
Custom16: string optional
Custom17: string optional
Custom18: string optional
Custom19: string optional
Custom2: string optional
Custom20: string optional
Custom21: string optional
Custom22: string optional
Custom23: string optional
Custom24: string optional
Custom25: string optional
Custom26: string optional
Custom27: string optional
Custom28: string optional
Custom29: string optional
Custom3: string optional
Custom30: string optional
Custom4: string optional
Custom5: string optional
Custom6: string optional
Custom7: string optional
Custom8: string optional
Custom9: string optional
DateOfBirth: DateTime? optional
DoNotProcessInvoicesAutomatically: bool optional
Email: string required
EnableGoCardlessPayments: bool optional
EzeepFreePrinting: bool optional
EzeepUserId: Guid? optional
Facebook: string optional
Flickr: string optional
FullName: string required
Gender: Nexudus.Coworking.Core.Enums.eGender optional
GeneralTermsAccepted: bool optional
Github: string optional
GoCardlessContractNumber: string optional
Google: string optional
HasAcceptedStripeACHAgreement: bool optional
HasVerifiedStripeACHDeposits: bool optional
Instagram: string optional
InvoiceDueDatePeriod: int? optional
InvoicingBusinessId: Id optional
KeyFobNumber: string optional
LandLine: string optional
Linkedin: string optional
MinutesSinceLastRenewal: int required read-only
MobilePhone: string optional
NextAutoInvoice: DateTime? optional
NickName: string optional
Notes: string optional
NotifyOnDelivery: bool optional
NotifyOnFailedPayment: bool optional
NotifyOnNewInvoice: bool optional
NotifyOnNewPayment: bool optional
PaperCutFreePrinting: bool optional
PaperCutPayAsYouPrint: bool optional
Pinterest: string optional
Position: string optional
PostCode: string optional
ProfileIsPublic: bool optional
ProfileSummary: string optional
ProfileTags: string optional
ProfileWebsite: string optional
PurchaseOrder: string optional
ReferenceNumber: string optional
RegistrationDate: DateTime? optional
RegularPaymentContractNumber: string optional
RegularPaymentProvider: Nexudus.Coworking.Core.Enums.eRegularPaymentProvider? optional
Salutation: string optional
ShowAlert: bool optional
ShowPayingMemberInvoices: bool optional
SimpleTimeZoneId: Id required
Skype: string optional
State: string optional
StripeACHBankToken: string optional
StripeACHCustomerToken: string optional
SyncToSquare: bool optional
Tag: string optional
TaxIDNumber: string optional
TaxRate: decimal? optional
TaxRateType: Nexudus.Coworking.Core.Enums.eCoworkerTaxRateType optional
Telegram: string optional
Tumblr: string optional
Twitter: string optional
UserId: Id optional
Vimeo: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworker
SystemId: string optional api-only
User defined data about this coworker. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AccessCardId": "Notes",
  "AccessPincode": "Notes",
  "Active": false,
  "Address": "Address",
  "AlertNote": "Tag",
  "AllowNetworkCheckin": false,
  "BankAccount": "Bank Account #",
  "BankBranch": "Branch / Sort Code",
  "BankName": "Bank Name",
  "BillingAddress": "Address",
  "BillingCityName": "CityName",
  "BillingCountryId": 12345678,
  "BillingEmail": "Address",
  "BillingName": "Address",
  "BillingPostCode": "PostCode",
  "BillingSimpleTimeZoneId": 12345678,
  "BillingState": "State",
  "Blogger": "Blogger",
  "BusinessArea": "BusinessArea",
  "CanAccessCommunity": false,
  "CanMakeBookings": false,
  "CanPurchaseEvents": false,
  "CanPurchaseProducts": false,
  "CardNumber": "Abc123456",
  "CheckinSinceLastRenewal": ,
  "CityName": "CityName",
  "CompanyName": "CompanyName",
  "CountryId": 12345678,
  "CoworkerType": 1,
  "CreateUser": false,
  "Custom1": "Custom1",
  "Custom10": "Custom1",
  "Custom11": "Custom1",
  "Custom12": "Custom1",
  "Custom13": "Custom1",
  "Custom14": "Custom1",
  "Custom15": "Custom1",
  "Custom16": "Custom1",
  "Custom17": "Custom1",
  "Custom18": "Custom1",
  "Custom19": "Custom1",
  "Custom2": "Custom1",
  "Custom20": "Custom1",
  "Custom21": "Custom1",
  "Custom22": "Custom1",
  "Custom23": "Custom1",
  "Custom24": "Custom1",
  "Custom25": "Custom1",
  "Custom26": "Custom1",
  "Custom27": "Custom1",
  "Custom28": "Custom1",
  "Custom29": "Custom1",
  "Custom3": "Custom1",
  "Custom30": "Custom1",
  "Custom4": "Custom1",
  "Custom5": "Custom1",
  "Custom6": "Custom1",
  "Custom7": "Custom1",
  "Custom8": "Custom1",
  "Custom9": "Custom1",
  "DateOfBirth": ,
  "DoNotProcessInvoicesAutomatically": false,
  "Email": "email@email.com",
  "EnableGoCardlessPayments": false,
  "EzeepFreePrinting": false,
  "EzeepUserId": ,
  "Facebook": "Facebook",
  "Flickr": "Flickr",
  "FullName": "Name",
  "Gender": 1,
  "GeneralTermsAccepted": false,
  "Github": "Github",
  "GoCardlessContractNumber": "false",
  "Google": "Google",
  "HasAcceptedStripeACHAgreement": false,
  "HasVerifiedStripeACHDeposits": false,
  "Instagram": "Instagram",
  "InvoiceDueDatePeriod": ,
  "InvoicingBusinessId": 12345678,
  "KeyFobNumber": "Notes",
  "LandLine": "LandLine",
  "Linkedin": "Linkedin",
  "MinutesSinceLastRenewal": ,
  "MobilePhone": "MobilePhone",
  "NextAutoInvoice": ,
  "NickName": "NickName",
  "Notes": "Notes",
  "NotifyOnDelivery": false,
  "NotifyOnFailedPayment": false,
  "NotifyOnNewInvoice": false,
  "NotifyOnNewPayment": false,
  "PaperCutFreePrinting": false,
  "PaperCutPayAsYouPrint": false,
  "Pinterest": "Pinterest",
  "Position": "Position",
  "PostCode": "PostCode",
  "ProfileIsPublic": false,
  "ProfileSummary": "BusinessArea",
  "ProfileTags": "BusinessArea",
  "ProfileWebsite": "ProfileWebsite",
  "PurchaseOrder": "false",
  "ReferenceNumber": "ReferenceNumber",
  "RegistrationDate": ,
  "RegularPaymentContractNumber": "false",
  "RegularPaymentProvider": 1,
  "Salutation": "Name",
  "ShowAlert": false,
  "ShowPayingMemberInvoices": false,
  "SimpleTimeZoneId": 12345678,
  "Skype": "Skype",
  "State": "State",
  "StripeACHBankToken": "Abc123456",
  "StripeACHCustomerToken": "Abc123456",
  "SyncToSquare": false,
  "Tag": "Tag",
  "TaxIDNumber": "State",
  "TaxRate": ,
  "TaxRateType": 1,
  "Telegram": "Telegram",
  "Tumblr": "Tumblr",
  "Twitter": "Twitter",
  "UserId": 12345678,
  "Vimeo": "Vimeo",
  "UniqueId": "83bbd366-9992-4da6-8f7d-7363e25fbfd9",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a Coworker

This endpoint allows you to GET a list of coworkers based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/spaces/coworkers?...

๐Ÿ”’ Requires role "Coworker-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=FullName
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search coworker records based on their different properties.
Id number
?Id=12345678
Coworker_AccessCardId string
?Coworker_AccessCardId=...
Coworker_AccessPincode string
?Coworker_AccessPincode=...
Coworker_Active bool
?Coworker_Active=...
Coworker_Address string
?Coworker_Address=...
Coworker_AlertNote string
?Coworker_AlertNote=...
Coworker_AllowNetworkCheckin bool
?Coworker_AllowNetworkCheckin=...
Coworker_BankAccount string
?Coworker_BankAccount=...
Coworker_BankBranch string
?Coworker_BankBranch=...
Coworker_BankName string
?Coworker_BankName=...
Coworker_BillingAddress string
?Coworker_BillingAddress=...
Coworker_BillingCityName string
?Coworker_BillingCityName=...
Coworker_BillingCountry Country
?Coworker_BillingCountry=...
Coworker_BillingEmail string
?Coworker_BillingEmail=...
Coworker_BillingName string
?Coworker_BillingName=...
Coworker_BillingPostCode string
?Coworker_BillingPostCode=...
Coworker_BillingSimpleTimeZone SimpleTimeZone
?Coworker_BillingSimpleTimeZone=...
Coworker_BillingState string
?Coworker_BillingState=...
Coworker_Blogger string
?Coworker_Blogger=...
Coworker_BusinessArea string
?Coworker_BusinessArea=...
Coworker_CanAccessCommunity bool
?Coworker_CanAccessCommunity=...
Coworker_CanMakeBookings bool
?Coworker_CanMakeBookings=...
Coworker_CanPurchaseEvents bool
?Coworker_CanPurchaseEvents=...
Coworker_CanPurchaseProducts bool
?Coworker_CanPurchaseProducts=...
Coworker_CardNumber string
?Coworker_CardNumber=...
Coworker_CheckinSinceLastRenewal int
?Coworker_CheckinSinceLastRenewal=...
Coworker_CityName string
?Coworker_CityName=...
Coworker_CompanyName string
?Coworker_CompanyName=...
Coworker_Country Country
?Coworker_Country=...
Coworker_CoworkerType Nexudus.Coworking.Core.Enums.eCoworkerRecordType
?Coworker_CoworkerType=...
Coworker_CreateUser bool
?Coworker_CreateUser=...
Coworker_Custom1 string
?Coworker_Custom1=...
Coworker_Custom10 string
?Coworker_Custom10=...
Coworker_Custom11 string
?Coworker_Custom11=...
Coworker_Custom12 string
?Coworker_Custom12=...
Coworker_Custom13 string
?Coworker_Custom13=...
Coworker_Custom14 string
?Coworker_Custom14=...
Coworker_Custom15 string
?Coworker_Custom15=...
Coworker_Custom16 string
?Coworker_Custom16=...
Coworker_Custom17 string
?Coworker_Custom17=...
Coworker_Custom18 string
?Coworker_Custom18=...
Coworker_Custom19 string
?Coworker_Custom19=...
Coworker_Custom2 string
?Coworker_Custom2=...
Coworker_Custom20 string
?Coworker_Custom20=...
Coworker_Custom21 string
?Coworker_Custom21=...
Coworker_Custom22 string
?Coworker_Custom22=...
Coworker_Custom23 string
?Coworker_Custom23=...
Coworker_Custom24 string
?Coworker_Custom24=...
Coworker_Custom25 string
?Coworker_Custom25=...
Coworker_Custom26 string
?Coworker_Custom26=...
Coworker_Custom27 string
?Coworker_Custom27=...
Coworker_Custom28 string
?Coworker_Custom28=...
Coworker_Custom29 string
?Coworker_Custom29=...
Coworker_Custom3 string
?Coworker_Custom3=...
Coworker_Custom30 string
?Coworker_Custom30=...
Coworker_Custom4 string
?Coworker_Custom4=...
Coworker_Custom5 string
?Coworker_Custom5=...
Coworker_Custom6 string
?Coworker_Custom6=...
Coworker_Custom7 string
?Coworker_Custom7=...
Coworker_Custom8 string
?Coworker_Custom8=...
Coworker_Custom9 string
?Coworker_Custom9=...
Coworker_DateOfBirth DateTime?
?Coworker_DateOfBirth=...
Coworker_DoNotProcessInvoicesAutomatically bool
?Coworker_DoNotProcessInvoicesAutomatically=...
Coworker_Email string
?Coworker_Email=...
Coworker_EnableGoCardlessPayments bool
?Coworker_EnableGoCardlessPayments=...
Coworker_EzeepFreePrinting bool
?Coworker_EzeepFreePrinting=...
Coworker_EzeepUserId Guid?
?Coworker_EzeepUserId=...
Coworker_Facebook string
?Coworker_Facebook=...
Coworker_Flickr string
?Coworker_Flickr=...
Coworker_FullName string
?Coworker_FullName=...
Coworker_Gender Nexudus.Coworking.Core.Enums.eGender
?Coworker_Gender=...
Coworker_GeneralTermsAccepted bool
?Coworker_GeneralTermsAccepted=...
Coworker_Github string
?Coworker_Github=...
Coworker_GoCardlessContractNumber string
?Coworker_GoCardlessContractNumber=...
Coworker_Google string
?Coworker_Google=...
Coworker_HasAcceptedStripeACHAgreement bool
?Coworker_HasAcceptedStripeACHAgreement=...
Coworker_HasVerifiedStripeACHDeposits bool
?Coworker_HasVerifiedStripeACHDeposits=...
Coworker_Instagram string
?Coworker_Instagram=...
Coworker_InvoiceDueDatePeriod int?
?Coworker_InvoiceDueDatePeriod=...
Coworker_InvoicingBusiness Business
?Coworker_InvoicingBusiness=...
Coworker_KeyFobNumber string
?Coworker_KeyFobNumber=...
Coworker_LandLine string
?Coworker_LandLine=...
Coworker_Linkedin string
?Coworker_Linkedin=...
Coworker_MinutesSinceLastRenewal int
?Coworker_MinutesSinceLastRenewal=...
Coworker_MobilePhone string
?Coworker_MobilePhone=...
Coworker_NextAutoInvoice DateTime?
?Coworker_NextAutoInvoice=...
Coworker_NickName string
?Coworker_NickName=...
Coworker_Notes string
?Coworker_Notes=...
Coworker_NotifyOnDelivery bool
?Coworker_NotifyOnDelivery=...
Coworker_NotifyOnFailedPayment bool
?Coworker_NotifyOnFailedPayment=...
Coworker_NotifyOnNewInvoice bool
?Coworker_NotifyOnNewInvoice=...
Coworker_NotifyOnNewPayment bool
?Coworker_NotifyOnNewPayment=...
Coworker_PaperCutFreePrinting bool
?Coworker_PaperCutFreePrinting=...
Coworker_PaperCutPayAsYouPrint bool
?Coworker_PaperCutPayAsYouPrint=...
Coworker_Pinterest string
?Coworker_Pinterest=...
Coworker_Position string
?Coworker_Position=...
Coworker_PostCode string
?Coworker_PostCode=...
Coworker_ProfileIsPublic bool
?Coworker_ProfileIsPublic=...
Coworker_ProfileSummary string
?Coworker_ProfileSummary=...
Coworker_ProfileTags string
?Coworker_ProfileTags=...
Coworker_ProfileWebsite string
?Coworker_ProfileWebsite=...
Coworker_PurchaseOrder string
?Coworker_PurchaseOrder=...
Coworker_ReferenceNumber string
?Coworker_ReferenceNumber=...
Coworker_RegistrationDate DateTime?
?Coworker_RegistrationDate=...
Coworker_RegularPaymentContractNumber string
?Coworker_RegularPaymentContractNumber=...
Coworker_RegularPaymentProvider Nexudus.Coworking.Core.Enums.eRegularPaymentProvider?
?Coworker_RegularPaymentProvider=...
Coworker_Salutation string
?Coworker_Salutation=...
Coworker_ShowAlert bool
?Coworker_ShowAlert=...
Coworker_ShowPayingMemberInvoices bool
?Coworker_ShowPayingMemberInvoices=...
Coworker_SimpleTimeZone SimpleTimeZone
?Coworker_SimpleTimeZone=...
Coworker_Skype string
?Coworker_Skype=...
Coworker_State string
?Coworker_State=...
Coworker_StripeACHBankToken string
?Coworker_StripeACHBankToken=...
Coworker_StripeACHCustomerToken string
?Coworker_StripeACHCustomerToken=...
Coworker_SyncToSquare bool
?Coworker_SyncToSquare=...
Coworker_Tag string
?Coworker_Tag=...
Coworker_TaxIDNumber string
?Coworker_TaxIDNumber=...
Coworker_TaxRate decimal?
?Coworker_TaxRate=...
Coworker_TaxRateType Nexudus.Coworking.Core.Enums.eCoworkerTaxRateType
?Coworker_TaxRateType=...
Coworker_Telegram string
?Coworker_Telegram=...
Coworker_Tumblr string
?Coworker_Tumblr=...
Coworker_Twitter string
?Coworker_Twitter=...
Coworker_User User
?Coworker_User=...
Coworker_Vimeo string
?Coworker_Vimeo=...
Coworker_InvoicingBusinessName string
?Coworker_InvoicingBusinessName=...
Coworker_UserFullName string
?Coworker_UserFullName=...
Coworker_UserIsAdmin string
?Coworker_UserIsAdmin=...
Coworker_UserLastAccess string
?Coworker_UserLastAccess=...
Coworker_UserActive string
?Coworker_UserActive=...
Coworker_UserReceiveCommunityDigest string
?Coworker_UserReceiveCommunityDigest=...
Coworker_UserReceiveEveryMessage string
?Coworker_UserReceiveEveryMessage=...
Coworker_Businesses List of Business
?Coworker_Businesses=...
Coworker_Teams List of Team
?Coworker_Teams=...

Range search querystring parameters
Lets you search coworker records based on a range of date or numeric values.
To_Coworker_CreatedOn date
?To_Coworker_CreatedOn=2010-01-01T20:32
From_Coworker_CreatedOn date
?From_Coworker_CreatedOn=2010-01-01T20:32
To_Coworker_UpdatedOn date
?To_Coworker_UpdatedOn=2010-01-01T20:32
From_Coworker_UpdatedOn date
?From_Coworker_UpdatedOn=2010-01-01T20:32
To_Coworker_DateOfBirth date
?To_Coworker_DateOfBirth=2010-01-01T20:32
From_Coworker_DateOfBirth date
?From_Coworker_DateOfBirth=2010-01-01T20:32
To_Coworker_TaxRate number
?To_Coworker_TaxRate=0
From_Coworker_TaxRate number
?From_Coworker_TaxRate=10
To_Coworker_CheckinSinceLastRenewal number
?To_Coworker_CheckinSinceLastRenewal=0
From_Coworker_CheckinSinceLastRenewal number
?From_Coworker_CheckinSinceLastRenewal=10
To_Coworker_MinutesSinceLastRenewal number
?To_Coworker_MinutesSinceLastRenewal=0
From_Coworker_MinutesSinceLastRenewal number
?From_Coworker_MinutesSinceLastRenewal=10
To_Coworker_NextAutoInvoice date
?To_Coworker_NextAutoInvoice=2010-01-01T20:32
From_Coworker_NextAutoInvoice date
?From_Coworker_NextAutoInvoice=2010-01-01T20:32
To_Coworker_InvoiceDueDatePeriod number
?To_Coworker_InvoiceDueDatePeriod=0
From_Coworker_InvoiceDueDatePeriod number
?From_Coworker_InvoiceDueDatePeriod=10
To_Coworker_RegistrationDate date
?To_Coworker_RegistrationDate=2010-01-01T20:32
From_Coworker_RegistrationDate date
?From_Coworker_RegistrationDate=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/spaces/coworkers?Coworker_FullName=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerType": 1,
        "FullName": "Name",
        "Salutation": "Name",
        "Gender": 1,
        "Email": "email@email.com",
        "CreateUser": false,
        "Address": "Address",
        "PostCode": "PostCode",
        "CityName": "CityName",
        "State": "State",
        "Country": ,
        "SimpleTimeZone": ,
        "MobilePhone": "MobilePhone",
        "LandLine": "LandLine",
        "DateOfBirth": ,
        "NickName": "NickName",
        "BusinessArea": "BusinessArea",
        "Position": "Position",
        "CompanyName": "CompanyName",
        "ProfileWebsite": "ProfileWebsite",
        "ProfileTags": "BusinessArea",
        "ProfileSummary": "BusinessArea",
        "Twitter": "Twitter",
        "Facebook": "Facebook",
        "Google": "Google",
        "Telegram": "Telegram",
        "Linkedin": "Linkedin",
        "Skype": "Skype",
        "Github": "Github",
        "Pinterest": "Pinterest",
        "Flickr": "Flickr",
        "Instagram": "Instagram",
        "Vimeo": "Vimeo",
        "Tumblr": "Tumblr",
        "Blogger": "Blogger",
        "ProfileIsPublic": false,
        "InvoicingBusiness": ,
        "BillingEmail": "Address",
        "BillingName": "Address",
        "BillingAddress": "Address",
        "BillingPostCode": "PostCode",
        "BillingCityName": "CityName",
        "BillingState": "State",
        "BillingCountry": ,
        "BillingSimpleTimeZone": ,
        "TaxRateType": 1,
        "TaxRate": ,
        "TaxIDNumber": "State",
        "BankName": "Bank Name",
        "BankAccount": "Bank Account #",
        "BankBranch": "Branch / Sort Code",
        "NotifyOnNewInvoice": false,
        "NotifyOnNewPayment": false,
        "NotifyOnFailedPayment": false,
        "ShowPayingMemberInvoices": false,
        "EnableGoCardlessPayments": false,
        "GoCardlessContractNumber": "false",
        "RegularPaymentProvider": 1,
        "RegularPaymentContractNumber": "false",
        "CardNumber": "Abc123456",
        "DoNotProcessInvoicesAutomatically": false,
        "AllowNetworkCheckin": false,
        "CheckinSinceLastRenewal": ,
        "MinutesSinceLastRenewal": ,
        "AccessCardId": "Notes",
        "AccessPincode": "Notes",
        "KeyFobNumber": "Notes",
        "NotifyOnDelivery": false,
        "EzeepUserId": ,
        "EzeepFreePrinting": false,
        "PaperCutPayAsYouPrint": false,
        "PaperCutFreePrinting": false,
        "CanMakeBookings": false,
        "CanPurchaseProducts": false,
        "CanPurchaseEvents": false,
        "CanAccessCommunity": false,
        "ReferenceNumber": "ReferenceNumber",
        "Tag": "Tag",
        "Notes": "Notes",
        "ShowAlert": false,
        "AlertNote": "Tag",
        "User": ,
        "Active": false,
        "NextAutoInvoice": ,
        "InvoiceDueDatePeriod": ,
        "RegistrationDate": ,
        "GeneralTermsAccepted": false,
        "Custom1": "Custom1",
        "Custom2": "Custom1",
        "Custom3": "Custom1",
        "Custom4": "Custom1",
        "Custom5": "Custom1",
        "Custom6": "Custom1",
        "Custom7": "Custom1",
        "Custom8": "Custom1",
        "Custom9": "Custom1",
        "Custom10": "Custom1",
        "Custom11": "Custom1",
        "Custom12": "Custom1",
        "Custom13": "Custom1",
        "Custom14": "Custom1",
        "Custom15": "Custom1",
        "Custom16": "Custom1",
        "Custom17": "Custom1",
        "Custom18": "Custom1",
        "Custom19": "Custom1",
        "Custom20": "Custom1",
        "Custom21": "Custom1",
        "Custom22": "Custom1",
        "Custom23": "Custom1",
        "Custom24": "Custom1",
        "Custom25": "Custom1",
        "Custom26": "Custom1",
        "Custom27": "Custom1",
        "Custom28": "Custom1",
        "Custom29": "Custom1",
        "Custom30": "Custom1",
        "StripeACHBankToken": "Abc123456",
        "StripeACHCustomerToken": "Abc123456",
        "HasAcceptedStripeACHAgreement": false,
        "HasVerifiedStripeACHDeposits": false,
        "PurchaseOrder": "false",
        "SyncToSquare": false,
        "CoworkerInvoicingBusinessName": "...",
        "CoworkerUserFullName": "...",
        "CoworkerUserIsAdmin": "...",
        "CoworkerUserLastAccess": "...",
        "CoworkerUserActive": "...",
        "CoworkerUserReceiveCommunityDigest": "...",
        "CoworkerUserReceiveEveryMessage": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e6fc8162-1b7e-454f-8b01-391625d1a7ca",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find Coworkers by IDs

Gets one or more coworker records based on their Id.
GET https://spaces.nexudus.com/api/spaces/coworkers?Coworker_Id=[:id1,:id2,...]

๐Ÿ”’ Requires role "Coworker-List"

Querystring parameters
Coworker_Id: array requried
?Coworker_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/spaces/coworkers?Coworker_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerType": 1,
        "FullName": "Name",
        "Salutation": "Name",
        "Gender": 1,
        "Email": "email@email.com",
        "CreateUser": false,
        "Address": "Address",
        "PostCode": "PostCode",
        "CityName": "CityName",
        "State": "State",
        "Country": ,
        "SimpleTimeZone": ,
        "MobilePhone": "MobilePhone",
        "LandLine": "LandLine",
        "DateOfBirth": ,
        "NickName": "NickName",
        "BusinessArea": "BusinessArea",
        "Position": "Position",
        "CompanyName": "CompanyName",
        "ProfileWebsite": "ProfileWebsite",
        "ProfileTags": "BusinessArea",
        "ProfileSummary": "BusinessArea",
        "Twitter": "Twitter",
        "Facebook": "Facebook",
        "Google": "Google",
        "Telegram": "Telegram",
        "Linkedin": "Linkedin",
        "Skype": "Skype",
        "Github": "Github",
        "Pinterest": "Pinterest",
        "Flickr": "Flickr",
        "Instagram": "Instagram",
        "Vimeo": "Vimeo",
        "Tumblr": "Tumblr",
        "Blogger": "Blogger",
        "ProfileIsPublic": false,
        "InvoicingBusiness": ,
        "BillingEmail": "Address",
        "BillingName": "Address",
        "BillingAddress": "Address",
        "BillingPostCode": "PostCode",
        "BillingCityName": "CityName",
        "BillingState": "State",
        "BillingCountry": ,
        "BillingSimpleTimeZone": ,
        "TaxRateType": 1,
        "TaxRate": ,
        "TaxIDNumber": "State",
        "BankName": "Bank Name",
        "BankAccount": "Bank Account #",
        "BankBranch": "Branch / Sort Code",
        "NotifyOnNewInvoice": false,
        "NotifyOnNewPayment": false,
        "NotifyOnFailedPayment": false,
        "ShowPayingMemberInvoices": false,
        "EnableGoCardlessPayments": false,
        "GoCardlessContractNumber": "false",
        "RegularPaymentProvider": 1,
        "RegularPaymentContractNumber": "false",
        "CardNumber": "Abc123456",
        "DoNotProcessInvoicesAutomatically": false,
        "AllowNetworkCheckin": false,
        "CheckinSinceLastRenewal": ,
        "MinutesSinceLastRenewal": ,
        "AccessCardId": "Notes",
        "AccessPincode": "Notes",
        "KeyFobNumber": "Notes",
        "NotifyOnDelivery": false,
        "EzeepUserId": ,
        "EzeepFreePrinting": false,
        "PaperCutPayAsYouPrint": false,
        "PaperCutFreePrinting": false,
        "CanMakeBookings": false,
        "CanPurchaseProducts": false,
        "CanPurchaseEvents": false,
        "CanAccessCommunity": false,
        "ReferenceNumber": "ReferenceNumber",
        "Tag": "Tag",
        "Notes": "Notes",
        "ShowAlert": false,
        "AlertNote": "Tag",
        "User": ,
        "Active": false,
        "NextAutoInvoice": ,
        "InvoiceDueDatePeriod": ,
        "RegistrationDate": ,
        "GeneralTermsAccepted": false,
        "Custom1": "Custom1",
        "Custom2": "Custom1",
        "Custom3": "Custom1",
        "Custom4": "Custom1",
        "Custom5": "Custom1",
        "Custom6": "Custom1",
        "Custom7": "Custom1",
        "Custom8": "Custom1",
        "Custom9": "Custom1",
        "Custom10": "Custom1",
        "Custom11": "Custom1",
        "Custom12": "Custom1",
        "Custom13": "Custom1",
        "Custom14": "Custom1",
        "Custom15": "Custom1",
        "Custom16": "Custom1",
        "Custom17": "Custom1",
        "Custom18": "Custom1",
        "Custom19": "Custom1",
        "Custom20": "Custom1",
        "Custom21": "Custom1",
        "Custom22": "Custom1",
        "Custom23": "Custom1",
        "Custom24": "Custom1",
        "Custom25": "Custom1",
        "Custom26": "Custom1",
        "Custom27": "Custom1",
        "Custom28": "Custom1",
        "Custom29": "Custom1",
        "Custom30": "Custom1",
        "StripeACHBankToken": "Abc123456",
        "StripeACHCustomerToken": "Abc123456",
        "HasAcceptedStripeACHAgreement": false,
        "HasVerifiedStripeACHDeposits": false,
        "PurchaseOrder": "false",
        "SyncToSquare": false,
        "CoworkerInvoicingBusinessName": "...",
        "CoworkerUserFullName": "...",
        "CoworkerUserIsAdmin": "...",
        "CoworkerUserLastAccess": "...",
        "CoworkerUserActive": "...",
        "CoworkerUserReceiveCommunityDigest": "...",
        "CoworkerUserReceiveEveryMessage": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1a05478a-8693-4c3c-acaf-694f228dd6e0",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "FullName",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single Coworker by Id

Gets one coworker record by its Id.
GET https://spaces.nexudus.com/api/spaces/coworkers/:Id

๐Ÿ”’ Requires role "Coworker-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/spaces/coworkers/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "AccessCardId": "Notes",
  "AccessPincode": "Notes",
  "Active": false,
  "Address": "Address",
  "AlertNote": "Tag",
  "AllowNetworkCheckin": false,
  "BankAccount": "Bank Account #",
  "BankBranch": "Branch / Sort Code",
  "BankName": "Bank Name",
  "BillingAddress": "Address",
  "BillingCityName": "CityName",
  "BillingCountryId": 12345678,
  "BillingEmail": "Address",
  "BillingName": "Address",
  "BillingPostCode": "PostCode",
  "BillingSimpleTimeZoneId": 12345678,
  "BillingState": "State",
  "Blogger": "Blogger",
  "BusinessArea": "BusinessArea",
  "CanAccessCommunity": false,
  "CanMakeBookings": false,
  "CanPurchaseEvents": false,
  "CanPurchaseProducts": false,
  "CardNumber": "Abc123456",
  "CheckinSinceLastRenewal": ,
  "CityName": "CityName",
  "CompanyName": "CompanyName",
  "CountryId": 12345678,
  "CoworkerType": 1,
  "CreateUser": false,
  "Custom1": "Custom1",
  "Custom10": "Custom1",
  "Custom11": "Custom1",
  "Custom12": "Custom1",
  "Custom13": "Custom1",
  "Custom14": "Custom1",
  "Custom15": "Custom1",
  "Custom16": "Custom1",
  "Custom17": "Custom1",
  "Custom18": "Custom1",
  "Custom19": "Custom1",
  "Custom2": "Custom1",
  "Custom20": "Custom1",
  "Custom21": "Custom1",
  "Custom22": "Custom1",
  "Custom23": "Custom1",
  "Custom24": "Custom1",
  "Custom25": "Custom1",
  "Custom26": "Custom1",
  "Custom27": "Custom1",
  "Custom28": "Custom1",
  "Custom29": "Custom1",
  "Custom3": "Custom1",
  "Custom30": "Custom1",
  "Custom4": "Custom1",
  "Custom5": "Custom1",
  "Custom6": "Custom1",
  "Custom7": "Custom1",
  "Custom8": "Custom1",
  "Custom9": "Custom1",
  "DateOfBirth": ,
  "DoNotProcessInvoicesAutomatically": false,
  "Email": "email@email.com",
  "EnableGoCardlessPayments": false,
  "EzeepFreePrinting": false,
  "EzeepUserId": ,
  "Facebook": "Facebook",
  "Flickr": "Flickr",
  "FullName": "Name",
  "Gender": 1,
  "GeneralTermsAccepted": false,
  "Github": "Github",
  "GoCardlessContractNumber": "false",
  "Google": "Google",
  "HasAcceptedStripeACHAgreement": false,
  "HasVerifiedStripeACHDeposits": false,
  "Instagram": "Instagram",
  "InvoiceDueDatePeriod": ,
  "InvoicingBusinessId": 12345678,
  "KeyFobNumber": "Notes",
  "LandLine": "LandLine",
  "Linkedin": "Linkedin",
  "MinutesSinceLastRenewal": ,
  "MobilePhone": "MobilePhone",
  "NextAutoInvoice": ,
  "NickName": "NickName",
  "Notes": "Notes",
  "NotifyOnDelivery": false,
  "NotifyOnFailedPayment": false,
  "NotifyOnNewInvoice": false,
  "NotifyOnNewPayment": false,
  "PaperCutFreePrinting": false,
  "PaperCutPayAsYouPrint": false,
  "Pinterest": "Pinterest",
  "Position": "Position",
  "PostCode": "PostCode",
  "ProfileIsPublic": false,
  "ProfileSummary": "BusinessArea",
  "ProfileTags": "BusinessArea",
  "ProfileWebsite": "ProfileWebsite",
  "PurchaseOrder": "false",
  "ReferenceNumber": "ReferenceNumber",
  "RegistrationDate": ,
  "RegularPaymentContractNumber": "false",
  "RegularPaymentProvider": 1,
  "Salutation": "Name",
  "ShowAlert": false,
  "ShowPayingMemberInvoices": false,
  "SimpleTimeZoneId": 12345678,
  "Skype": "Skype",
  "State": "State",
  "StripeACHBankToken": "Abc123456",
  "StripeACHCustomerToken": "Abc123456",
  "SyncToSquare": false,
  "Tag": "Tag",
  "TaxIDNumber": "State",
  "TaxRate": ,
  "TaxRateType": 1,
  "Telegram": "Telegram",
  "Tumblr": "Tumblr",
  "Twitter": "Twitter",
  "UserId": 12345678,
  "Vimeo": "Vimeo",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "9accf027-b7eb-4fd6-9dee-6629d8670c9d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new Coworker

Creates a new coworker.
POST https://spaces.nexudus.com/api/spaces/coworkers

๐Ÿ”’ Requires role "Coworker-Create"

Body parameters
CoworkerType: Nexudus.Coworking.Core.Enums.eCoworkerRecordType optional
FullName: string required
Salutation: string optional
Gender: Nexudus.Coworking.Core.Enums.eGender optional
Email: string required
CreateUser: bool optional
Address: string optional
PostCode: string optional
CityName: string optional
State: string optional
CountryId: number required
SimpleTimeZoneId: number required
MobilePhone: string optional
LandLine: string optional
DateOfBirth: DateTime? optional
NickName: string optional
BusinessArea: string optional
Position: string optional
CompanyName: string optional
ProfileWebsite: string optional
ProfileTags: string optional
ProfileSummary: string optional
Twitter: string optional
Facebook: string optional
Google: string optional
Telegram: string optional
Linkedin: string optional
Skype: string optional
Github: string optional
Pinterest: string optional
Flickr: string optional
Instagram: string optional
Vimeo: string optional
Tumblr: string optional
Blogger: string optional
ProfileIsPublic: bool optional
InvoicingBusinessId: number optional
BillingEmail: string optional
BillingName: string optional
BillingAddress: string optional
BillingPostCode: string optional
BillingCityName: string optional
BillingState: string optional
BillingCountryId: number optional
BillingSimpleTimeZoneId: number optional
TaxRateType: Nexudus.Coworking.Core.Enums.eCoworkerTaxRateType optional
TaxRate: decimal? optional
TaxIDNumber: string optional
BankName: string optional
BankAccount: string optional
BankBranch: string optional
NotifyOnNewInvoice: bool optional
NotifyOnNewPayment: bool optional
NotifyOnFailedPayment: bool optional
ShowPayingMemberInvoices: bool optional
EnableGoCardlessPayments: bool optional
GoCardlessContractNumber: string optional
RegularPaymentProvider: Nexudus.Coworking.Core.Enums.eRegularPaymentProvider? optional
RegularPaymentContractNumber: string optional
DoNotProcessInvoicesAutomatically: bool optional
AllowNetworkCheckin: bool optional
AccessCardId: string optional
AccessPincode: string optional
KeyFobNumber: string optional
NotifyOnDelivery: bool optional
EzeepUserId: Guid? optional
EzeepFreePrinting: bool optional
PaperCutPayAsYouPrint: bool optional
PaperCutFreePrinting: bool optional
CanMakeBookings: bool optional
CanPurchaseProducts: bool optional
CanPurchaseEvents: bool optional
CanAccessCommunity: bool optional
ReferenceNumber: string optional
Tag: string optional
Notes: string optional
ShowAlert: bool optional
AlertNote: string optional
Active: bool optional
InvoiceDueDatePeriod: int? optional
RegistrationDate: DateTime? optional
GeneralTermsAccepted: bool optional
Custom1: string optional
Custom2: string optional
Custom3: string optional
Custom4: string optional
Custom5: string optional
Custom6: string optional
Custom7: string optional
Custom8: string optional
Custom9: string optional
Custom10: string optional
Custom11: string optional
Custom12: string optional
Custom13: string optional
Custom14: string optional
Custom15: string optional
Custom16: string optional
Custom17: string optional
Custom18: string optional
Custom19: string optional
Custom20: string optional
Custom21: string optional
Custom22: string optional
Custom23: string optional
Custom24: string optional
Custom25: string optional
Custom26: string optional
Custom27: string optional
Custom28: string optional
Custom29: string optional
Custom30: string optional
StripeACHBankToken: string optional
StripeACHCustomerToken: string optional
HasAcceptedStripeACHAgreement: bool optional
HasVerifiedStripeACHDeposits: bool optional
PurchaseOrder: string optional
SyncToSquare: bool optional

Example request

POST https://spaces.nexudus.com/api/spaces/coworkers
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "CoworkerType": 1, //(check Enumerated values section below)
    "Businesses": [12345678, 87654321],
    "Teams": [12345678, 87654321],
    "FullName": "Name",
    "Salutation": "Name",
    "Gender": 1, //(check Enumerated values section below)
    "Email": "email@email.com",
    "CreateUser": false,
    "Address": "Address",
    "PostCode": "PostCode",
    "CityName": "CityName",
    "State": "State",
    "CountryId": 12345678,
    "SimpleTimeZoneId": 12345678,
    "MobilePhone": "MobilePhone",
    "LandLine": "LandLine",
    "DateOfBirth": ,
    "NickName": "NickName",
    "BusinessArea": "BusinessArea",
    "Position": "Position",
    "CompanyName": "CompanyName",
    "ProfileWebsite": "ProfileWebsite",
    "ProfileTags": "BusinessArea",
    "ProfileSummary": "BusinessArea",
    "Twitter": "Twitter",
    "Facebook": "Facebook",
    "Google": "Google",
    "Telegram": "Telegram",
    "Linkedin": "Linkedin",
    "Skype": "Skype",
    "Github": "Github",
    "Pinterest": "Pinterest",
    "Flickr": "Flickr",
    "Instagram": "Instagram",
    "Vimeo": "Vimeo",
    "Tumblr": "Tumblr",
    "Blogger": "Blogger",
    "ProfileIsPublic": false,
    "InvoicingBusinessId": 12345678,
    "BillingEmail": "Address",
    "BillingName": "Address",
    "BillingAddress": "Address",
    "BillingPostCode": "PostCode",
    "BillingCityName": "CityName",
    "BillingState": "State",
    "BillingCountryId": 12345678,
    "BillingSimpleTimeZoneId": 12345678,
    "TaxRateType": 1, //(check Enumerated values section below)
    "TaxRate": ,
    "TaxIDNumber": "State",
    "BankName": "Bank Name",
    "BankAccount": "Bank Account #",
    "BankBranch": "Branch / Sort Code",
    "NotifyOnNewInvoice": false,
    "NotifyOnNewPayment": false,
    "NotifyOnFailedPayment": false,
    "ShowPayingMemberInvoices": false,
    "EnableGoCardlessPayments": false,
    "GoCardlessContractNumber": "false",
    "RegularPaymentProvider": 1, //(check Enumerated values section below)
    "RegularPaymentContractNumber": "false",
    "DoNotProcessInvoicesAutomatically": false,
    "AllowNetworkCheckin": false,
    "AccessCardId": "Notes",
    "AccessPincode": "Notes",
    "KeyFobNumber": "Notes",
    "NotifyOnDelivery": false,
    "EzeepUserId": ,
    "EzeepFreePrinting": false,
    "PaperCutPayAsYouPrint": false,
    "PaperCutFreePrinting": false,
    "CanMakeBookings": false,
    "CanPurchaseProducts": false,
    "CanPurchaseEvents": false,
    "CanAccessCommunity": false,
    "ReferenceNumber": "ReferenceNumber",
    "Tag": "Tag",
    "Notes": "Notes",
    "ShowAlert": false,
    "AlertNote": "Tag",
    "Active": false,
    "InvoiceDueDatePeriod": ,
    "RegistrationDate": ,
    "GeneralTermsAccepted": false,
    "Custom1": "Custom1",
    "Custom2": "Custom1",
    "Custom3": "Custom1",
    "Custom4": "Custom1",
    "Custom5": "Custom1",
    "Custom6": "Custom1",
    "Custom7": "Custom1",
    "Custom8": "Custom1",
    "Custom9": "Custom1",
    "Custom10": "Custom1",
    "Custom11": "Custom1",
    "Custom12": "Custom1",
    "Custom13": "Custom1",
    "Custom14": "Custom1",
    "Custom15": "Custom1",
    "Custom16": "Custom1",
    "Custom17": "Custom1",
    "Custom18": "Custom1",
    "Custom19": "Custom1",
    "Custom20": "Custom1",
    "Custom21": "Custom1",
    "Custom22": "Custom1",
    "Custom23": "Custom1",
    "Custom24": "Custom1",
    "Custom25": "Custom1",
    "Custom26": "Custom1",
    "Custom27": "Custom1",
    "Custom28": "Custom1",
    "Custom29": "Custom1",
    "Custom30": "Custom1",
    "StripeACHBankToken": "Abc123456",
    "StripeACHCustomerToken": "Abc123456",
    "HasAcceptedStripeACHAgreement": false,
    "HasVerifiedStripeACHDeposits": false,
    "PurchaseOrder": "false",
    "SyncToSquare": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update Coworker

Updates an existing coworker.
PUT https://spaces.nexudus.com/api/spaces/coworkers

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

๐Ÿ”’ Requires role "Coworker-Edit"

Body parameters
Id: number required
The unique Id of the coworker to update.
CoworkerType: Nexudus.Coworking.Core.Enums.eCoworkerRecordType cleared if missing
FullName: string cleared if missing
Salutation: string cleared if missing
Gender: Nexudus.Coworking.Core.Enums.eGender cleared if missing
Email: string cleared if missing
Address: string cleared if missing
PostCode: string cleared if missing
CityName: string cleared if missing
State: string cleared if missing
CountryId: number cleared if missing
SimpleTimeZoneId: number cleared if missing
MobilePhone: string cleared if missing
LandLine: string cleared if missing
DateOfBirth: DateTime? cleared if missing
NickName: string cleared if missing
BusinessArea: string cleared if missing
Position: string cleared if missing
CompanyName: string cleared if missing
ProfileWebsite: string cleared if missing
ProfileTags: string cleared if missing
ProfileSummary: string cleared if missing
Twitter: string cleared if missing
Facebook: string cleared if missing
Google: string cleared if missing
Telegram: string cleared if missing
Linkedin: string cleared if missing
Skype: string cleared if missing
Github: string cleared if missing
Pinterest: string cleared if missing
Flickr: string cleared if missing
Instagram: string cleared if missing
Vimeo: string cleared if missing
Tumblr: string cleared if missing
Blogger: string cleared if missing
ProfileIsPublic: bool cleared if missing
InvoicingBusinessId: number cleared if missing
BillingEmail: string cleared if missing
BillingName: string cleared if missing
BillingAddress: string cleared if missing
BillingPostCode: string cleared if missing
BillingCityName: string cleared if missing
BillingState: string cleared if missing
BillingCountryId: number cleared if missing
BillingSimpleTimeZoneId: number cleared if missing
TaxRateType: Nexudus.Coworking.Core.Enums.eCoworkerTaxRateType cleared if missing
TaxRate: decimal? cleared if missing
TaxIDNumber: string cleared if missing
BankName: string cleared if missing
BankAccount: string cleared if missing
BankBranch: string cleared if missing
NotifyOnNewInvoice: bool cleared if missing
NotifyOnNewPayment: bool cleared if missing
NotifyOnFailedPayment: bool cleared if missing
ShowPayingMemberInvoices: bool cleared if missing
EnableGoCardlessPayments: bool cleared if missing
GoCardlessContractNumber: string cleared if missing
RegularPaymentProvider: Nexudus.Coworking.Core.Enums.eRegularPaymentProvider? cleared if missing
RegularPaymentContractNumber: string cleared if missing
DoNotProcessInvoicesAutomatically: bool cleared if missing
AllowNetworkCheckin: bool cleared if missing
AccessCardId: string cleared if missing
AccessPincode: string cleared if missing
KeyFobNumber: string cleared if missing
NotifyOnDelivery: bool cleared if missing
EzeepUserId: Guid? cleared if missing
EzeepFreePrinting: bool cleared if missing
PaperCutPayAsYouPrint: bool cleared if missing
PaperCutFreePrinting: bool cleared if missing
CanMakeBookings: bool cleared if missing
CanPurchaseProducts: bool cleared if missing
CanPurchaseEvents: bool cleared if missing
CanAccessCommunity: bool cleared if missing
ReferenceNumber: string cleared if missing
Tag: string cleared if missing
Notes: string cleared if missing
ShowAlert: bool cleared if missing
AlertNote: string cleared if missing
UserId: number cleared if missing
Active: bool cleared if missing
NextAutoInvoice: DateTime? cleared if missing
InvoiceDueDatePeriod: int? cleared if missing
RegistrationDate: DateTime? cleared if missing
GeneralTermsAccepted: bool cleared if missing
Custom1: string cleared if missing
Custom2: string cleared if missing
Custom3: string cleared if missing
Custom4: string cleared if missing
Custom5: string cleared if missing
Custom6: string cleared if missing
Custom7: string cleared if missing
Custom8: string cleared if missing
Custom9: string cleared if missing
Custom10: string cleared if missing
Custom11: string cleared if missing
Custom12: string cleared if missing
Custom13: string cleared if missing
Custom14: string cleared if missing
Custom15: string cleared if missing
Custom16: string cleared if missing
Custom17: string cleared if missing
Custom18: string cleared if missing
Custom19: string cleared if missing
Custom20: string cleared if missing
Custom21: string cleared if missing
Custom22: string cleared if missing
Custom23: string cleared if missing
Custom24: string cleared if missing
Custom25: string cleared if missing
Custom26: string cleared if missing
Custom27: string cleared if missing
Custom28: string cleared if missing
Custom29: string cleared if missing
Custom30: string cleared if missing
StripeACHBankToken: string cleared if missing
StripeACHCustomerToken: string cleared if missing
HasAcceptedStripeACHAgreement: bool cleared if missing
HasVerifiedStripeACHDeposits: bool cleared if missing
PurchaseOrder: string cleared if missing
SyncToSquare: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/spaces/coworkers
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "CoworkerType": 1, //(check Enumerated values section below)
    "Businesses": [12345678, 87654321],
    "Teams": [12345678, 87654321],
    "FullName": "Name",
    "Salutation": "Name",
    "Gender": 1, //(check Enumerated values section below)
    "Email": "email@email.com",
    "CreateUser": false,
    "Address": "Address",
    "PostCode": "PostCode",
    "CityName": "CityName",
    "State": "State",
    "CountryId": 12345678,
    "SimpleTimeZoneId": 12345678,
    "MobilePhone": "MobilePhone",
    "LandLine": "LandLine",
    "DateOfBirth": ,
    "NickName": "NickName",
    "BusinessArea": "BusinessArea",
    "Position": "Position",
    "CompanyName": "CompanyName",
    "ProfileWebsite": "ProfileWebsite",
    "ProfileTags": "BusinessArea",
    "ProfileSummary": "BusinessArea",
    "Twitter": "Twitter",
    "Facebook": "Facebook",
    "Google": "Google",
    "Telegram": "Telegram",
    "Linkedin": "Linkedin",
    "Skype": "Skype",
    "Github": "Github",
    "Pinterest": "Pinterest",
    "Flickr": "Flickr",
    "Instagram": "Instagram",
    "Vimeo": "Vimeo",
    "Tumblr": "Tumblr",
    "Blogger": "Blogger",
    "ProfileIsPublic": false,
    "InvoicingBusinessId": 12345678,
    "BillingEmail": "Address",
    "BillingName": "Address",
    "BillingAddress": "Address",
    "BillingPostCode": "PostCode",
    "BillingCityName": "CityName",
    "BillingState": "State",
    "BillingCountryId": 12345678,
    "BillingSimpleTimeZoneId": 12345678,
    "TaxRateType": 1, //(check Enumerated values section below)
    "TaxRate": ,
    "TaxIDNumber": "State",
    "BankName": "Bank Name",
    "BankAccount": "Bank Account #",
    "BankBranch": "Branch / Sort Code",
    "NotifyOnNewInvoice": false,
    "NotifyOnNewPayment": false,
    "NotifyOnFailedPayment": false,
    "ShowPayingMemberInvoices": false,
    "EnableGoCardlessPayments": false,
    "GoCardlessContractNumber": "false",
    "RegularPaymentProvider": 1, //(check Enumerated values section below)
    "RegularPaymentContractNumber": "false",
    "DoNotProcessInvoicesAutomatically": false,
    "AllowNetworkCheckin": false,
    "AccessCardId": "Notes",
    "AccessPincode": "Notes",
    "KeyFobNumber": "Notes",
    "NotifyOnDelivery": false,
    "EzeepUserId": ,
    "EzeepFreePrinting": false,
    "PaperCutPayAsYouPrint": false,
    "PaperCutFreePrinting": false,
    "CanMakeBookings": false,
    "CanPurchaseProducts": false,
    "CanPurchaseEvents": false,
    "CanAccessCommunity": false,
    "ReferenceNumber": "ReferenceNumber",
    "Tag": "Tag",
    "Notes": "Notes",
    "ShowAlert": false,
    "AlertNote": "Tag",
    "Active": false,
    "InvoiceDueDatePeriod": ,
    "RegistrationDate": ,
    "GeneralTermsAccepted": false,
    "Custom1": "Custom1",
    "Custom2": "Custom1",
    "Custom3": "Custom1",
    "Custom4": "Custom1",
    "Custom5": "Custom1",
    "Custom6": "Custom1",
    "Custom7": "Custom1",
    "Custom8": "Custom1",
    "Custom9": "Custom1",
    "Custom10": "Custom1",
    "Custom11": "Custom1",
    "Custom12": "Custom1",
    "Custom13": "Custom1",
    "Custom14": "Custom1",
    "Custom15": "Custom1",
    "Custom16": "Custom1",
    "Custom17": "Custom1",
    "Custom18": "Custom1",
    "Custom19": "Custom1",
    "Custom20": "Custom1",
    "Custom21": "Custom1",
    "Custom22": "Custom1",
    "Custom23": "Custom1",
    "Custom24": "Custom1",
    "Custom25": "Custom1",
    "Custom26": "Custom1",
    "Custom27": "Custom1",
    "Custom28": "Custom1",
    "Custom29": "Custom1",
    "Custom30": "Custom1",
    "StripeACHBankToken": "Abc123456",
    "StripeACHCustomerToken": "Abc123456",
    "HasAcceptedStripeACHAgreement": false,
    "HasVerifiedStripeACHDeposits": false,
    "PurchaseOrder": "false",
    "SyncToSquare": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Commands

Commands allow to perform actions against one or more coworker records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for coworker records.
GET https://spaces.nexudus.com/api/spaces/coworkers/commands

Example request

GET https://spaces.nexudus.com/api/spaces/coworkers/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more coworker record IDs.
POST https://spaces.nexudus.com/api/spaces/coworkers/runacommand
๐Ÿ”’ Requires role "Coworker-Edit"

Example request

POST https://spaces.nexudus.com/api/spaces/coworkers/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Enumerated values

CoworkerType

GET /api/utils/enums?name=eCoworkerRecordType

Gender

GET /api/utils/enums?name=eGender

TaxRateType

GET /api/utils/enums?name=eCoworkerTaxRateType

RegularPaymentProvider

GET /api/utils/enums?name=eRegularPaymentProvider

Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

Avatar

GET https://spaces.nexudus.com/api/spaces/coworkers/getavatar/:id
URL parameters
Id: number required
The id of the Coworker to get the avatar for.

BannerImage

GET https://spaces.nexudus.com/api/spaces/coworkers/getbannerimage/:id
URL parameters
Id: number required
The id of the Coworker to get the bannerimage for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.