Zentry.Workspaces.Api v1.0

Base URLs:

• http://localhost:5186
• https://api.workspace.zentrypass.com

Authentication

• API Key (API_KEY)
  • Parameter Name: Api-Key Authentication, in: header.

Address

GetAddresses

GET /Address

Parameters

Name	In	Type	Required	Description
Query	query	string	false	The query to search for

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AddressSearchMatch]	false	none	none
» address	string¦null	false	none	The address
» geo	Geo	false	none	none
»» latitude	number(double)	true	none	none
»» longitude	number(double)	true	none	none

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Admin

AddUserRole

POST /Admin/role

Body parameter

{
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string"
  },
  "role": "LocationAdmin",
  "workspaceId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	AddUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	User

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

RemoveUserRole

DELETE /Admin/role

Body parameter

{
  "email": "johnsmit@zentrypass.com",
  "role": "LocationAdmin",
  "workspaceId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	RemoveUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetUsersWithRole

GET /Admin/{tenantId}/role/{role}

Parameters

Name	In	Type	Required	Description
getUsersWithRoleRequest	header	GetUsersWithRoleRequest	false	none
tenantId	path	string	true	none
role	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Application

CreateApplication

POST /Application/create

Body parameter

{
  "name": "string",
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string"
  },
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetApplications

POST /Application

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetApplicationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ApplicationIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateApplication

PUT /Application/{id}

Body parameter

{
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "marketplacePrice": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "rooms": [
        {
          "name": "Conference room",
          "pricePerHour": 5000,
          "marketplacePricePerHour": 5000,
          "pricePerDay": 50000,
          "marketplacePricePerDay": 50000,
          "quantity": 2,
          "amenities": [
            "White board",
            "TV"
          ],
          "capacity": 20,
          "maxReservationMinutes": 60,
          "pictureUrls": [
            "string"
          ],
          "autoApproveReservations": false
        }
      ],
      "autoApproveReservations": true
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UpdateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveApplicationInquiry

PUT /Application/approve-inquiry

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationInquiryRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

SubmitApplication

PUT /Application/{id}/submit

Body parameter

{
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "marketplacePrice": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "rooms": [
        {
          "name": "Conference room",
          "pricePerHour": 5000,
          "marketplacePricePerHour": 5000,
          "pricePerDay": 50000,
          "marketplacePricePerDay": 50000,
          "quantity": 2,
          "amenities": [
            "White board",
            "TV"
          ],
          "capacity": 20,
          "maxReservationMinutes": 60,
          "pictureUrls": [
            "string"
          ],
          "autoApproveReservations": false
        }
      ],
      "autoApproveReservations": true
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	SubmitApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DenyApplication

PUT /Application/deny

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DenyApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveApplication

PUT /Application/approve

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Workspace

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

InviteWorkspace

POST /Application/invite

Body parameter

{
  "name": "string",
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string"
  },
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	InviteWorkspaceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

SendApplicationReminder

POST /Application/remind

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SendApplicationReminderRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Location

GetLocations

POST /Location

Body parameter

{
  "offset": 0,
  "limit": 25,
  "excludeLocationsNotOnMarketplace": true,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "maxMarketplacePrice": 20000,
  "statuses": [
    "Active"
  ],
  "maxTokens": 10
}

Parameters

Name	In	Type	Required	Description
body	body	GetLocationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ExtendedLocationIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpsertLocation

POST /Location/upsert

Body parameter

{
  "workspaceId": "184d3163ee1ffbbdb38b6c07",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    }
  },
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "price": 10000,
  "marketplacePrice": 1500,
  "phone": "5555555555",
  "checkInInstructions": "Visit the front desk",
  "description": "Panoramic views of the San Francisco skyline",
  "waiverUrl": "https://example.com/waiver.pdf",
  "termsOfSerivceUrl": "https://example.com/terms.pdf",
  "autoApproveReservations": false
}

Parameters

Name	In	Type	Required	Description
id	query	string	false	none
body	body	UpsertLocationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ExtendedLocation

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UploadLocationImage

POST /Location/image

Body parameter

file: string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UploadWaiver

POST /Location/waiver

Body parameter

file: string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UploadTerms

POST /Location/terms

Body parameter

file: string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

LocationIsOpen

GET /Location/is-open

Parameters

Name	In	Type	Required	Description
Id	query	string	false	The id of the location
Date	query	string(date-time)	false	The date to check

Responses

Status	Meaning	Description	Schema
200	OK	OK	IsOpenResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

LocationClosure

GetLocationClosures

POST /LocationClosure

Body parameter

{
  "offset": 0,
  "limit": 25,
  "locationIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetLocationClosuresRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	LocationClosureIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateLocationClosures

POST /LocationClosure/create

Body parameter

{
  "closures": [
    {
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "locationId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CreateMultipleLocationClosuresRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	Closure	false	none	none
»» id	string	true	none	The unique identifier for this entity
»» dateCreated	string(date-time)	true	none	The initial date this entity was created
»» dateUpdated	string(date-time)	true	none	The last time this entity was updated
»» dateRange	DateRange	true	none	none
»»» from	string(date-time)	true	none	The start of the date range
»»» to	string(date-time)	true	none	The end of the date range
»» workspaceId	string	true	none	Zentry Pass Workspace Id
»» recurrence	Recurrence	true	none	none
»» recurrenceEndDate	string(date-time)¦null	false	none	The end date of the recurrence

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» locationId	string	true	none	Zentry Pass Location Id
»» type	ClosureType	true	none	none

Enumerated Values

Property	Value
recurrence	None
recurrence	Daily
recurrence	Weekly
recurrence	Monthly
recurrence	Yearly
type	Default
type	ComingSoon

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DeleteLocationClosure

DELETE /LocationClosure/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

MemberApplication

GetMemberApplications

POST /MemberApplication

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Request"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetMemberApplicationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplicationIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateMemberApplication

POST /MemberApplication/create

Body parameter

{
  "workspaceId": "string",
  "userId": "string",
  "workspaceLicenseTemplateId": "string",
  "locationId": "string",
  "requestedActivationDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateMemberApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateMemberApplication

PUT /MemberApplication/{id}

Body parameter

{
  "activationDate": "2019-08-24T14:15:22Z",
  "requestedActivationDate": "2019-08-24T14:15:22Z",
  "locationId": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UpdateMemberApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DenyMemberApplication

POST /MemberApplication/{id}/deny

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveMemberApplicationRequest

POST /MemberApplication/{id}/approve-request

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

SubmitMemberApplication

POST /MemberApplication/{id}/submit

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveMemberApplication

POST /MemberApplication/{id}/approve

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	MemberApplication

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Room

GetRooms

POST /Room

Body parameter

{
  "offset": 0,
  "limit": 25,
  "excludeRoomsNotOnMarketplace": true,
  "ids": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "minimumCapacity": 10,
  "maxMarketplacePricePerHour": 20000,
  "maxTokensPerHour": 30
}

Parameters

Name	In	Type	Required	Description
body	body	GetRoomsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ExtendedRoomIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpsertRoom

POST /Room/upsert

Body parameter

{
  "locationId": "564d3163ee1iibbdb38b6c43",
  "name": "Conference room",
  "pricePerHour": 5000,
  "pricePerDay": 50000,
  "marketplacePricePerHour": 5000,
  "marketplacePricePerDay": 50000,
  "quantity": 2,
  "amenities": [
    "White board",
    "TV"
  ],
  "capacity": 20,
  "maxReservationMinutes": 60,
  "pictureUrls": [
    "string"
  ],
  "autoApproveReservations": false
}

Parameters

Name	In	Type	Required	Description
id	query	string	false	none
body	body	UpsertRoomRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ExtendedRoom

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

RoomIsOpen

GET /Room/is-open

Parameters

Name	In	Type	Required	Description
Id	query	string	false	The id of the room
Date	query	string(date-time)	false	The date to check

Responses

Status	Meaning	Description	Schema
200	OK	OK	IsOpenResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

RoomClosure

GetRoomClosures

POST /RoomClosure

Body parameter

{
  "offset": 0,
  "limit": 25,
  "roomIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetRoomClosuresRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	RoomClosureIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateRoomClosures

POST /RoomClosure/create

Body parameter

{
  "closures": [
    {
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "roomId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CreateMultipleRoomClosuresRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	Closure	false	none	none
»» id	string	true	none	The unique identifier for this entity
»» dateCreated	string(date-time)	true	none	The initial date this entity was created
»» dateUpdated	string(date-time)	true	none	The last time this entity was updated
»» dateRange	DateRange	true	none	none
»»» from	string(date-time)	true	none	The start of the date range
»»» to	string(date-time)	true	none	The end of the date range
»» workspaceId	string	true	none	Zentry Pass Workspace Id
»» recurrence	Recurrence	true	none	none
»» recurrenceEndDate	string(date-time)¦null	false	none	The end date of the recurrence

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» roomId	string	true	none	Zentry Pass Room Id
»» type	ClosureType	true	none	none

Enumerated Values

Property	Value
recurrence	None
recurrence	Daily
recurrence	Weekly
recurrence	Monthly
recurrence	Yearly
type	Default
type	ComingSoon

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DeleteRoomClosure

DELETE /RoomClosure/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UserLocation

GetUserLocations

POST /UserLocation

Body parameter

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetUserLocationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserLocationIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateUserLocation

POST /UserLocation/create

Body parameter

{
  "userId": "string",
  "workspaceId": "string",
  "locationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateUserLocationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserLocation

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DeleteUserLocation

DELETE /UserLocation/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Workspace

GetWorkspace

GET /Workspace/my

Responses

Status	Meaning	Description	Schema
200	OK	OK	Workspace

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetWorkspaces

POST /Workspace

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetWorkspacesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateWorkspace

PUT /Workspace/{id}

Body parameter

{
  "logoUrl": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UpsertWorkspaceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Workspace

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

WorkspaceMember

GetWorkspaceMembers

POST /WorkspaceMember

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetWorkspaceMembersRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceMemberIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Schemas

AddUserRoleRequest

{
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "role": "LocationAdmin",
  "workspaceId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
contact	Contact	true	none	none
role	string	true	none	The name of the role to add
workspaceId	string	true	none	Zentry Pass Workspace Id

Address

{
  "line1": "11 N 4th St",
  "line2": "APT 101",
  "state": "Missouri",
  "city": "St. Louis",
  "zipCode": "63102"
}

Name	Type	Required	Restrictions	Description
line1	string¦null	false	none	The main address
line2	string¦null	false	none	The secondary address
state	string¦null	false	none	The state
city	string¦null	false	none	The city
zipCode	string¦null	false	none	The zip code

AddressSearchMatch

{
  "address": "string",
  "geo": {
    "latitude": 38.62,
    "longitude": -90.18
  }
}

Name	Type	Required	Restrictions	Description
address	string¦null	false	none	The address
geo	Geo	false	none	none

Application

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "status": "Inquiry",
  "name": "string",
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "marketplacePrice": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "rooms": [
        {
          "name": "Conference room",
          "pricePerHour": 5000,
          "marketplacePricePerHour": 5000,
          "pricePerDay": 50000,
          "marketplacePricePerDay": 50000,
          "quantity": 2,
          "amenities": [
            "White board",
            "TV"
          ],
          "capacity": 20,
          "maxReservationMinutes": 60,
          "pictureUrls": [
            "string"
          ],
          "autoApproveReservations": false
        }
      ],
      "autoApproveReservations": true
    }
  ],
  "ownerId": "string",
  "ownerEmail": "string",
  "workspaceId": "string",
  "wasInvited": true
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
status	ApplicationStatus	true	none	none
name	string	true	none	none
contact	Contact	true	none	none
description	string	true	none	none
locations	[ApplicationLocation]¦null	false	none	none
ownerId	string¦null	false	none	none
ownerEmail	string¦null	false	none	none
workspaceId	string¦null	false	none	none
wasInvited	boolean	true	none	none

ApplicationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "status": "Inquiry",
      "name": "string",
      "contact": {
        "name": "string",
        "email": "string",
        "phone": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "description": "string",
      "locations": [
        {
          "name": "string",
          "address": {
            "line1": "11 N 4th St",
            "line2": "APT 101",
            "state": "Missouri",
            "city": "St. Louis",
            "zipCode": "63102"
          },
          "schedule": {
            "monday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "tuesday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "wednesday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "thursday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "friday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "saturday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            },
            "sunday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 40
            }
          },
          "amenities": [
            "string"
          ],
          "price": 0,
          "marketplacePrice": 0,
          "pictureUrls": [
            "string"
          ],
          "phone": "string",
          "checkInInstructions": "string",
          "description": "string",
          "waiverUrl": "string",
          "termsOfSerivceUrl": "string",
          "rooms": [
            {
              "name": "Conference room",
              "pricePerHour": 5000,
              "marketplacePricePerHour": 5000,
              "pricePerDay": 50000,
              "marketplacePricePerDay": 50000,
              "quantity": 2,
              "amenities": [
                "White board",
                "TV"
              ],
              "capacity": 20,
              "maxReservationMinutes": 60,
              "pictureUrls": [
                "string"
              ],
              "autoApproveReservations": false
            }
          ],
          "autoApproveReservations": true
        }
      ],
      "ownerId": "string",
      "ownerEmail": "string",
      "workspaceId": "string",
      "wasInvited": true
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Application]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

ApplicationLocation

{
  "name": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    }
  },
  "amenities": [
    "string"
  ],
  "price": 0,
  "marketplacePrice": 0,
  "pictureUrls": [
    "string"
  ],
  "phone": "string",
  "checkInInstructions": "string",
  "description": "string",
  "waiverUrl": "string",
  "termsOfSerivceUrl": "string",
  "rooms": [
    {
      "name": "Conference room",
      "pricePerHour": 5000,
      "marketplacePricePerHour": 5000,
      "pricePerDay": 50000,
      "marketplacePricePerDay": 50000,
      "quantity": 2,
      "amenities": [
        "White board",
        "TV"
      ],
      "capacity": 20,
      "maxReservationMinutes": 60,
      "pictureUrls": [
        "string"
      ],
      "autoApproveReservations": false
    }
  ],
  "autoApproveReservations": true
}

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
address	Address	false	none	none
schedule	Schedule	false	none	none
amenities	[string]¦null	false	none	none
price	integer(int64)¦null	false	none	none
marketplacePrice	integer(int64)¦null	false	none	none
pictureUrls	[string]¦null	false	none	none
phone	string¦null	false	none	none
checkInInstructions	string¦null	false	none	none
description	string¦null	false	none	none
waiverUrl	string¦null	false	none	none
termsOfSerivceUrl	string¦null	false	none	none
rooms	[ApplicationLocationRoom]¦null	false	none	none
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.

ApplicationLocationRoom

{
  "name": "Conference room",
  "pricePerHour": 5000,
  "marketplacePricePerHour": 5000,
  "pricePerDay": 50000,
  "marketplacePricePerDay": 50000,
  "quantity": 2,
  "amenities": [
    "White board",
    "TV"
  ],
  "capacity": 20,
  "maxReservationMinutes": 60,
  "pictureUrls": [
    "string"
  ],
  "autoApproveReservations": false
}

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Name of the room
pricePerHour	integer(int64)¦null	false	none	How much the room costs per hour
marketplacePricePerHour	integer(int64)¦null	false	none	How much the room costs on the marketplace per hour
pricePerDay	integer(int64)¦null	false	none	How much the room costs per day
marketplacePricePerDay	integer(int64)¦null	false	none	How much the room costs per day on the marketplace
quantity	integer(int32)¦null	false	none	How many of these rooms are available
amenities	[string]¦null	false	none	The amenities avialble in the room
capacity	integer(int32)¦null	false	none	How many people are allowed in the room
maxReservationMinutes	integer(int32)¦null	false	none	Maximum number of minutes the room can be reserved for
pictureUrls	[string]¦null	false	none	List of urls for the pictures
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.

ApplicationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
ownerIds	[string]¦null	false	none	none
statuses	[ApplicationStatus]¦null	false	none	none

ApplicationStatus

"Inquiry"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Inquiry
anonymous	Pending
anonymous	Submitted
anonymous	Approved
anonymous	Denied

ApproveApplicationInquiryRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

ApproveApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

Closure

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "dateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "workspaceId": "string",
  "recurrence": "None",
  "recurrenceEndDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
dateRange	DateRange	true	none	none
workspaceId	string	true	none	Zentry Pass Workspace Id
recurrence	Recurrence	true	none	none
recurrenceEndDate	string(date-time)¦null	false	none	The end date of the recurrence

ClosureType

"Default"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Default
anonymous	ComingSoon

Contact

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "firstName": "string",
  "lastName": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
email	string	true	none	none
phone	string¦null	false	none	none
firstName	string¦null	false	read-only	none
lastName	string¦null	false	read-only	none

CreateApplicationRequest

{
  "name": "string",
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "description": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
contact	Contact	true	none	none
description	string	true	none	none

CreateLocationClosureRequest

{
  "dateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "workspaceId": "string",
  "locationId": "string",
  "recurrence": "None",
  "recurrenceEndDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
dateRange	DateRange	true	none	none
workspaceId	string	true	none	Zentry Pass Workspace Id
locationId	string	true	none	Zentry Pass Location Id
recurrence	Recurrence	true	none	none
recurrenceEndDate	string(date-time)¦null	false	none	The end date of the recurrence

CreateMemberApplicationRequest

{
  "workspaceId": "string",
  "userId": "string",
  "workspaceLicenseTemplateId": "string",
  "locationId": "string",
  "requestedActivationDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
workspaceId	string	true	none	Zentry Pass Workspace Id of the workspace the application is for
userId	string	true	none	Zentry Pass User Id of the user requesting the license
workspaceLicenseTemplateId	string	true	none	The license the user is requesting
locationId	string¦null	false	none	The location the license will be used at
requestedActivationDate	string(date-time)	true	none	The requested day the license should become active

CreateMultipleLocationClosuresRequest

{
  "closures": [
    {
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "locationId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Name	Type	Required	Restrictions	Description
closures	[CreateLocationClosureRequest]	true	none	none

CreateMultipleRoomClosuresRequest

{
  "closures": [
    {
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "roomId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Name	Type	Required	Restrictions	Description
closures	[CreateRoomClosureRequest]	true	none	none

CreateRoomClosureRequest

{
  "dateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "workspaceId": "string",
  "roomId": "string",
  "recurrence": "None",
  "recurrenceEndDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
dateRange	DateRange	true	none	none
workspaceId	string	true	none	Zentry Pass Workspace Id
roomId	string	true	none	Zentry Pass Room Id
recurrence	Recurrence	true	none	none
recurrenceEndDate	string(date-time)¦null	false	none	The end date of the recurrence

CreateUserLocationRequest

{
  "userId": "string",
  "workspaceId": "string",
  "locationId": "string"
}

Name	Type	Required	Restrictions	Description
userId	string	true	none	Zentry Pass User Id
workspaceId	string	true	none	Zentry Pass Workspace Id
locationId	string	true	none	Zentry Pass Location Id

DateRange

{
  "from": "2019-08-24T14:15:22Z",
  "to": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
from	string(date-time)	true	none	The start of the date range
to	string(date-time)	true	none	The end of the date range

DenyApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

ExtendedLocation

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "184d3163ee1ffbbdb38b6c07",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    }
  },
  "price": 1500,
  "marketplacePrice": 1500,
  "geo": {
    "latitude": 38.62,
    "longitude": -90.18
  },
  "timeZone": "America/Chicago",
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "phone": "5555555555",
  "checkInInstructions": "Visit the front desk",
  "description": "Panoramic views of the San Francisco skyline",
  "waiverUrl": "string",
  "termsOfSerivceUrl": "string",
  "autoApproveReservations": true,
  "status": "Active",
  "tokenCost": 5
}

Name	Type	Required	Restrictions	Description
anonymous	Location	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» tokenCost	integer(int32)	true	none	How many tokens this location costs for license users

ExtendedLocationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "workspaceId": "184d3163ee1ffbbdb38b6c07",
      "name": "The Zentrys - St. Louis",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "price": 1500,
      "marketplacePrice": 1500,
      "geo": {
        "latitude": 38.62,
        "longitude": -90.18
      },
      "timeZone": "America/Chicago",
      "pictureUrls": [
        "https://example.com/photo1.jpg",
        "https://example.com/photo2.jpg"
      ],
      "amenities": [
        "Wi-Fi",
        "Pickleball"
      ],
      "phone": "5555555555",
      "checkInInstructions": "Visit the front desk",
      "description": "Panoramic views of the San Francisco skyline",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "autoApproveReservations": true,
      "status": "Active",
      "tokenCost": 5
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[ExtendedLocation]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

ExtendedRoom

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "locationId": "564d3163ee1iibbdb38b6c43",
  "location": {
    "id": "184d3163ee1ffbbdb38b6c07",
    "dateCreated": "2019-08-24T14:15:22Z",
    "dateUpdated": "2019-08-24T14:15:22Z",
    "workspaceId": "184d3163ee1ffbbdb38b6c07",
    "name": "The Zentrys - St. Louis",
    "address": {
      "line1": "11 N 4th St",
      "line2": "APT 101",
      "state": "Missouri",
      "city": "St. Louis",
      "zipCode": "63102"
    },
    "schedule": {
      "monday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "tuesday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "wednesday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "thursday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "friday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "saturday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "sunday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      }
    },
    "price": 1500,
    "marketplacePrice": 1500,
    "geo": {
      "latitude": 38.62,
      "longitude": -90.18
    },
    "timeZone": "America/Chicago",
    "pictureUrls": [
      "https://example.com/photo1.jpg",
      "https://example.com/photo2.jpg"
    ],
    "amenities": [
      "Wi-Fi",
      "Pickleball"
    ],
    "phone": "5555555555",
    "checkInInstructions": "Visit the front desk",
    "description": "Panoramic views of the San Francisco skyline",
    "waiverUrl": "string",
    "termsOfSerivceUrl": "string",
    "autoApproveReservations": true,
    "status": "Active"
  },
  "name": "Conference room",
  "pricePerHour": 5000,
  "pricePerDay": 50000,
  "marketplacePricePerHour": 5000,
  "marketplacePricePerDay": 50000,
  "quantity": 2,
  "amenities": [
    "White board",
    "TV"
  ],
  "capacity": 20,
  "maxReservationMinutes": 60,
  "pictureUrls": [
    "string"
  ],
  "autoApproveReservations": false,
  "tokenCostPerHour": 30,
  "tokenCostPerDay": 30
}

Name	Type	Required	Restrictions	Description
anonymous	Room	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» tokenCostPerHour	integer(int32)	true	none	How many tokens this room costs per hour for license users
» tokenCostPerDay	integer(int32)¦null	false	none	How many tokens this room costs per day for license users

ExtendedRoomIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "locationId": "564d3163ee1iibbdb38b6c43",
      "location": {
        "id": "184d3163ee1ffbbdb38b6c07",
        "dateCreated": "2019-08-24T14:15:22Z",
        "dateUpdated": "2019-08-24T14:15:22Z",
        "workspaceId": "184d3163ee1ffbbdb38b6c07",
        "name": "The Zentrys - St. Louis",
        "address": {
          "line1": "11 N 4th St",
          "line2": "APT 101",
          "state": "Missouri",
          "city": "St. Louis",
          "zipCode": "63102"
        },
        "schedule": {
          "monday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "tuesday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "wednesday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "thursday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "friday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "saturday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          },
          "sunday": {
            "isOpen": true,
            "open": "09:00:00",
            "close": "17:00:00",
            "maxVisitors": 40
          }
        },
        "price": 1500,
        "marketplacePrice": 1500,
        "geo": {
          "latitude": 38.62,
          "longitude": -90.18
        },
        "timeZone": "America/Chicago",
        "pictureUrls": [
          "https://example.com/photo1.jpg",
          "https://example.com/photo2.jpg"
        ],
        "amenities": [
          "Wi-Fi",
          "Pickleball"
        ],
        "phone": "5555555555",
        "checkInInstructions": "Visit the front desk",
        "description": "Panoramic views of the San Francisco skyline",
        "waiverUrl": "string",
        "termsOfSerivceUrl": "string",
        "autoApproveReservations": true,
        "status": "Active"
      },
      "name": "Conference room",
      "pricePerHour": 5000,
      "pricePerDay": 50000,
      "marketplacePricePerHour": 5000,
      "marketplacePricePerDay": 50000,
      "quantity": 2,
      "amenities": [
        "White board",
        "TV"
      ],
      "capacity": 20,
      "maxReservationMinutes": 60,
      "pictureUrls": [
        "string"
      ],
      "autoApproveReservations": false,
      "tokenCostPerHour": 30,
      "tokenCostPerDay": 30
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[ExtendedRoom]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

Geo

{
  "latitude": 38.62,
  "longitude": -90.18
}

Name	Type	Required	Restrictions	Description
latitude	number(double)	true	none	none
longitude	number(double)	true	none	none

GeoSearch

{
  "maxMiles": 25,
  "latitude": 38.62,
  "longitude": -90.18
}

Name	Type	Required	Restrictions	Description
maxMiles	number(double)	true	none	The maximum range in miles from the lat/lng
latitude	number(double)	true	none	The latitude
longitude	number(double)	true	none	The longitude

GetApplicationsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	ApplicationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetLocationClosuresRequest

{
  "offset": 0,
  "limit": 25,
  "locationIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	LocationClosureQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetLocationsRequest

{
  "offset": 0,
  "limit": 25,
  "excludeLocationsNotOnMarketplace": true,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "maxMarketplacePrice": 20000,
  "statuses": [
    "Active"
  ],
  "maxTokens": 10
}

Used to find locations

Name	Type	Required	Restrictions	Description
anonymous	LocationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» maxTokens	integer(int64)¦null	false	none	The maximum token cost

GetMemberApplicationsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Request"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	MemberApplicationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetRoomClosuresRequest

{
  "offset": 0,
  "limit": 25,
  "roomIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	RoomClosureQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetRoomsRequest

{
  "offset": 0,
  "limit": 25,
  "excludeRoomsNotOnMarketplace": true,
  "ids": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "minimumCapacity": 10,
  "maxMarketplacePricePerHour": 20000,
  "maxTokensPerHour": 30
}

Name	Type	Required	Restrictions	Description
anonymous	RoomQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» maxTokensPerHour	integer(int64)¦null	false	none	The maximum token cost per hour

GetUserLocationsRequest

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	UserLocationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUsersWithRoleRequest

{
  "role": "string",
  "tenantId": "string"
}

Name	Type	Required	Restrictions	Description
role	string	true	none	none
tenantId	string	true	none	none

GetWorkspaceMembersRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	WorkspaceMemberQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetWorkspacesRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	WorkspaceQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

InviteWorkspaceRequest

{
  "name": "string",
  "contact": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "description": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
contact	Contact	true	none	none
description	string	true	none	none

IsOpenResponse

{
  "isOpen": true,
  "closureType": "Default"
}

Name	Type	Required	Restrictions	Description
isOpen	boolean	true	none	Flag indicating if the entity is open
closureType	ClosureType	false	none	none

Location

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "184d3163ee1ffbbdb38b6c07",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    }
  },
  "price": 1500,
  "marketplacePrice": 1500,
  "geo": {
    "latitude": 38.62,
    "longitude": -90.18
  },
  "timeZone": "America/Chicago",
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "phone": "5555555555",
  "checkInInstructions": "Visit the front desk",
  "description": "Panoramic views of the San Francisco skyline",
  "waiverUrl": "string",
  "termsOfSerivceUrl": "string",
  "autoApproveReservations": true,
  "status": "Active"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
workspaceId	string	true	none	The workspace this location belongs to
name	string	true	none	The name of this location
address	Address	true	none	none
schedule	Schedule	true	none	none
price	integer(int64)	true	none	How much a day pass costs
marketplacePrice	integer(int64)¦null	false	none	How much a day pass costs on the marketplace
geo	Geo	true	none	none
timeZone	string	true	none	The time zone this location is in
pictureUrls	[string]	true	none	A list of urls for the pictures
amenities	[string]	true	none	A list of amenities this location offers
phone	string	true	none	The front desk phone number for this location
checkInInstructions	string	true	none	Instructions on how users should check-in while visiting this location
description	string¦null	false	none	A description of this location
waiverUrl	string	true	none	The url to the waiver users agree to before visiting
termsOfSerivceUrl	string	true	none	The url to the terms of service users agree to before visiting
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.
status	LocationStatus	true	none	none

LocationClosure

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "dateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "workspaceId": "string",
  "recurrence": "None",
  "recurrenceEndDate": "2019-08-24T14:15:22Z",
  "locationId": "string",
  "type": "Default"
}

Name	Type	Required	Restrictions	Description
anonymous	Closure	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» locationId	string	true	none	Zentry Pass Location Id
» type	ClosureType	true	none	none

LocationClosureIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "type": "Default"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[LocationClosure]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

LocationClosureQuery

{
  "offset": 0,
  "limit": 25,
  "locationIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
locationIds	[string]¦null	false	none	List of Zentry Pass location ids

LocationQuery

{
  "offset": 0,
  "limit": 25,
  "excludeLocationsNotOnMarketplace": true,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "maxMarketplacePrice": 20000,
  "statuses": [
    "Active"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
excludeLocationsNotOnMarketplace	boolean¦null	false	none	Exclude locations that are not on marketplace. Is internal only for backwards compatibility.
ids	[string]¦null	false	none	List of Zentry Pass Location Ids
workspaceIds	[string]¦null	false	none	List of Zentry Pass Workspace Ids
searchText	string¦null	false	none	Search by name or address
geoSearch	GeoSearch	false	none	none
state	string¦null	false	none	Search for locations by state code
amenities	[string]¦null	false	none	Search for locations with these amenities
maxMarketplacePrice	integer(int64)¦null	false	none	The maximum price for marketplace visits. Stored in cents.
statuses	[LocationStatus]¦null	false	none	List of location statuses to filter by

LocationStatus

"Active"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Active
anonymous	Inactive

MemberApplication

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "string",
  "userId": "string",
  "workspaceLicenseTemplateId": "string",
  "locationId": "string",
  "status": "Request",
  "requestedActivationDate": "2019-08-24T14:15:22Z",
  "activationDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
workspaceId	string	true	none	Zentry Pass Workspace Id of the workspace the application is for
userId	string	true	none	Zentry Pass User Id of the user requesting the license
workspaceLicenseTemplateId	string	true	none	The license the user is requesting
locationId	string¦null	false	none	The location the license will be used at
status	MemberApplicationStatus	true	none	none
requestedActivationDate	string(date-time)	true	none	The requested day the license should become active
activationDate	string(date-time)¦null	false	none	The day the license should become active

MemberApplicationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "workspaceId": "string",
      "userId": "string",
      "workspaceLicenseTemplateId": "string",
      "locationId": "string",
      "status": "Request",
      "requestedActivationDate": "2019-08-24T14:15:22Z",
      "activationDate": "2019-08-24T14:15:22Z"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[MemberApplication]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

MemberApplicationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Request"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
workspaceIds	[string]¦null	false	none	none
userIds	[string]¦null	false	none	none
statuses	[MemberApplicationStatus]¦null	false	none	none

MemberApplicationStatus

"Request"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Request
anonymous	Pending
anonymous	Submitted
anonymous	Approved
anonymous	Denied

Recurrence

"None"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Daily
anonymous	Weekly
anonymous	Monthly
anonymous	Yearly

RemoveUserRoleRequest

{
  "email": "johnsmit@zentrypass.com",
  "role": "LocationAdmin",
  "workspaceId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	The email of the user
role	string	true	none	The name of the role to remove
workspaceId	string	true	none	Zentry Pass Workspace Id

Room

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "locationId": "564d3163ee1iibbdb38b6c43",
  "location": {
    "id": "184d3163ee1ffbbdb38b6c07",
    "dateCreated": "2019-08-24T14:15:22Z",
    "dateUpdated": "2019-08-24T14:15:22Z",
    "workspaceId": "184d3163ee1ffbbdb38b6c07",
    "name": "The Zentrys - St. Louis",
    "address": {
      "line1": "11 N 4th St",
      "line2": "APT 101",
      "state": "Missouri",
      "city": "St. Louis",
      "zipCode": "63102"
    },
    "schedule": {
      "monday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "tuesday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "wednesday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "thursday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "friday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "saturday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      },
      "sunday": {
        "isOpen": true,
        "open": "09:00:00",
        "close": "17:00:00",
        "maxVisitors": 40
      }
    },
    "price": 1500,
    "marketplacePrice": 1500,
    "geo": {
      "latitude": 38.62,
      "longitude": -90.18
    },
    "timeZone": "America/Chicago",
    "pictureUrls": [
      "https://example.com/photo1.jpg",
      "https://example.com/photo2.jpg"
    ],
    "amenities": [
      "Wi-Fi",
      "Pickleball"
    ],
    "phone": "5555555555",
    "checkInInstructions": "Visit the front desk",
    "description": "Panoramic views of the San Francisco skyline",
    "waiverUrl": "string",
    "termsOfSerivceUrl": "string",
    "autoApproveReservations": true,
    "status": "Active"
  },
  "name": "Conference room",
  "pricePerHour": 5000,
  "pricePerDay": 50000,
  "marketplacePricePerHour": 5000,
  "marketplacePricePerDay": 50000,
  "quantity": 2,
  "amenities": [
    "White board",
    "TV"
  ],
  "capacity": 20,
  "maxReservationMinutes": 60,
  "pictureUrls": [
    "string"
  ],
  "autoApproveReservations": false
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
locationId	string	true	none	Zentry Pass location id
location	Location	true	none	none
name	string	true	none	Name of the room
pricePerHour	integer(int64)	true	none	How much the room costs per hour
pricePerDay	integer(int64)¦null	false	none	How much the room costs per day
marketplacePricePerHour	integer(int64)¦null	false	none	How much the room costs per hour on the marketplace
marketplacePricePerDay	integer(int64)¦null	false	none	How much the room costs per day on the marketplace
quantity	integer(int32)	true	none	How many of these rooms are available
amenities	[string]	true	none	The amenities avialble in the room
capacity	integer(int32)	true	none	How many people are allowed in the room
maxReservationMinutes	integer(int32)	true	none	Maximum number of minutes the room can be reserved for
pictureUrls	[string]	true	none	List of urls for the pictures
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.

RoomClosure

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "dateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "workspaceId": "string",
  "recurrence": "None",
  "recurrenceEndDate": "2019-08-24T14:15:22Z",
  "roomId": "string",
  "type": "Default"
}

Name	Type	Required	Restrictions	Description
anonymous	Closure	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» roomId	string	true	none	Zentry Pass Room Id
» type	ClosureType	true	none	none

RoomClosureIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "dateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "workspaceId": "string",
      "recurrence": "None",
      "recurrenceEndDate": "2019-08-24T14:15:22Z",
      "roomId": "string",
      "type": "Default"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[RoomClosure]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

RoomClosureQuery

{
  "offset": 0,
  "limit": 25,
  "roomIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
roomIds	[string]¦null	false	none	List of Zentry Pass room ids

RoomQuery

{
  "offset": 0,
  "limit": 25,
  "excludeRoomsNotOnMarketplace": true,
  "ids": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "state": "MO",
  "amenities": [
    "Female Only",
    "Parking",
    "Coffee"
  ],
  "minimumCapacity": 10,
  "maxMarketplacePricePerHour": 20000
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
excludeRoomsNotOnMarketplace	boolean¦null	false	none	Exclude room that are not on marketplace. Is internal only for backwards compatibility.
ids	[string]¦null	false	none	List of Zentry Pass room ids
locationIds	[string]¦null	false	none	List of Zentry Pass location ids
searchText	string¦null	false	none	Search by name or address
geoSearch	GeoSearch	false	none	none
state	string¦null	false	none	Search for rooms by state code
amenities	[string]¦null	false	none	Search for rooms with these amenities
minimumCapacity	integer(int32)¦null	false	none	The minimum capacity for rooms
maxMarketplacePricePerHour	integer(int64)¦null	false	none	The maximum price for marketplace visits. Stored in cents.

Schedule

{
  "monday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "tuesday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "wednesday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "thursday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "friday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "saturday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  },
  "sunday": {
    "isOpen": true,
    "open": "09:00:00",
    "close": "17:00:00",
    "maxVisitors": 40
  }
}

Name	Type	Required	Restrictions	Description
monday	ScheduleDay	true	none	none
tuesday	ScheduleDay	true	none	none
wednesday	ScheduleDay	true	none	none
thursday	ScheduleDay	true	none	none
friday	ScheduleDay	true	none	none
saturday	ScheduleDay	true	none	none
sunday	ScheduleDay	true	none	none

ScheduleDay

{
  "isOpen": true,
  "open": "09:00:00",
  "close": "17:00:00",
  "maxVisitors": 40
}

Name	Type	Required	Restrictions	Description
isOpen	boolean	true	none	Flag indicating if the entity is open on this day
open	string(date-span)	true	none	The time the entity opens
close	string(date-span)	true	none	The time the entity closes
maxVisitors	integer(int32)¦null	false	none	Maximum number of day passes for this day

SendApplicationReminderRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

SubmitApplicationRequest

{
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "marketplacePrice": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "rooms": [
        {
          "name": "Conference room",
          "pricePerHour": 5000,
          "marketplacePricePerHour": 5000,
          "pricePerDay": 50000,
          "marketplacePricePerDay": 50000,
          "quantity": 2,
          "amenities": [
            "White board",
            "TV"
          ],
          "capacity": 20,
          "maxReservationMinutes": 60,
          "pictureUrls": [
            "string"
          ],
          "autoApproveReservations": false
        }
      ],
      "autoApproveReservations": true
    }
  ]
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
locations	[ApplicationLocation]¦null	false	none	none

UpdateApplicationRequest

{
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 40
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "marketplacePrice": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string",
      "rooms": [
        {
          "name": "Conference room",
          "pricePerHour": 5000,
          "marketplacePricePerHour": 5000,
          "pricePerDay": 50000,
          "marketplacePricePerDay": 50000,
          "quantity": 2,
          "amenities": [
            "White board",
            "TV"
          ],
          "capacity": 20,
          "maxReservationMinutes": 60,
          "pictureUrls": [
            "string"
          ],
          "autoApproveReservations": false
        }
      ],
      "autoApproveReservations": true
    }
  ]
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
locations	[ApplicationLocation]¦null	false	none	none

UpdateMemberApplicationRequest

{
  "activationDate": "2019-08-24T14:15:22Z",
  "requestedActivationDate": "2019-08-24T14:15:22Z",
  "locationId": "string"
}

Name	Type	Required	Restrictions	Description
activationDate	string(date-time)¦null	false	none	The day the license should become active
requestedActivationDate	string(date-time)	true	none	The requested day the license should become active
locationId	string¦null	false	none	The location the license will be used at

UpsertLocationRequest

{
  "workspaceId": "184d3163ee1ffbbdb38b6c07",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 40
    }
  },
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "price": 10000,
  "marketplacePrice": 1500,
  "phone": "5555555555",
  "checkInInstructions": "Visit the front desk",
  "description": "Panoramic views of the San Francisco skyline",
  "waiverUrl": "https://example.com/waiver.pdf",
  "termsOfSerivceUrl": "https://example.com/terms.pdf",
  "autoApproveReservations": false
}

Name	Type	Required	Restrictions	Description
workspaceId	string	true	none	The workspace this location belongs to
name	string	true	none	The name of this location
address	Address	true	none	none
schedule	Schedule	true	none	none
pictureUrls	[string]	true	none	A list of urls for the pictures
amenities	[string]	true	none	A list of amenities this location offers
price	integer(int64)	true	none	The updated price in cents
marketplacePrice	integer(int64)¦null	false	none	How much a day pass costs on the marketplace
phone	string	true	none	The front desk phone number for this location
checkInInstructions	string	true	none	Instructions on how users should check-in while visiting this location
description	string¦null	false	none	A description of this location
waiverUrl	string	true	none	The url to the waiver users agree to before visiting
termsOfSerivceUrl	string	true	none	The url to the terms of service users agree to before visiting
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.

UpsertRoomRequest

{
  "locationId": "564d3163ee1iibbdb38b6c43",
  "name": "Conference room",
  "pricePerHour": 5000,
  "pricePerDay": 50000,
  "marketplacePricePerHour": 5000,
  "marketplacePricePerDay": 50000,
  "quantity": 2,
  "amenities": [
    "White board",
    "TV"
  ],
  "capacity": 20,
  "maxReservationMinutes": 60,
  "pictureUrls": [
    "string"
  ],
  "autoApproveReservations": false
}

Name	Type	Required	Restrictions	Description
locationId	string	true	none	Zentry Pass location id
name	string	true	none	Name of the room
pricePerHour	integer(int64)	true	none	How much the room costs per hour
pricePerDay	integer(int64)¦null	false	none	How much the room costs per day
marketplacePricePerHour	integer(int64)¦null	false	none	How much the room costs per hour on the marketplace
marketplacePricePerDay	integer(int64)¦null	false	none	How much the room costs per day on the marketplace
quantity	integer(int32)	true	none	How many of these rooms are available
amenities	[string]	true	none	The amenities avialble in the room
capacity	integer(int32)	true	none	How many people are allowed in the room
maxReservationMinutes	integer(int32)	true	none	Maximum number of minutes the room can be reserved for
pictureUrls	[string]	true	none	List of urls for the pictures
autoApproveReservations	boolean	true	none	Flag indicating if reservations should be auto approved when created.

UpsertWorkspaceRequest

{
  "logoUrl": "string"
}

Name	Type	Required	Restrictions	Description
logoUrl	string¦null	false	none	The url of the logo image

User

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "pictureUrl": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
email	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
pictureUrl	string¦null	false	none	none

UserIPagedResponse

{
  "data": [
    {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "pictureUrl": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[User]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

UserLocation

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "workspaceId": "string",
  "locationId": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
userId	string	true	none	Zentry Pass User Id
workspaceId	string	true	none	Zentry Pass Workspace Id
locationId	string	true	none	Zentry Pass Location Id

UserLocationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "workspaceId": "string",
      "locationId": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[UserLocation]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

UserLocationQuery

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ],
  "locationIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
workspaceIds	[string]¦null	false	none	none
locationIds	[string]¦null	false	none	none
userIds	[string]¦null	false	none	none

Workspace

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "Zentry Pass",
  "email": "workspace@zentrypass.com",
  "logoUrl": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
name	string	true	none	The name of this workspace
email	string	true	none	The email used for communicating with this workspace
logoUrl	string¦null	false	none	The url of the logo image

WorkspaceIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "Zentry Pass",
      "email": "workspace@zentrypass.com",
      "logoUrl": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Workspace]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

WorkspaceMember

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "string",
  "locationId": "string",
  "userId": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
workspaceId	string	true	none	Zentry Pass Workspace Id
locationId	string¦null	false	none	Zentry Pass Location Id
userId	string	true	none	Zentry Pass User Id

WorkspaceMemberIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "workspaceId": "string",
      "locationId": "string",
      "userId": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[WorkspaceMember]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

WorkspaceMemberQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ],
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
workspaceIds	[string]¦null	false	none	none
userIds	[string]¦null	false	none	none

WorkspaceQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none