Zentry.Workspaces.Api v1.0

Base URLs:

• https://api.workspace.zentrypass.com

Authentication

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

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	None

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"
  ]
}

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

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
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/submit

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
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

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

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

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

Location

GetLocations

POST /Location

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "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

UpdateLocation

PUT /Location

Body parameter

{
  "id": "686d3163ee1ffbbdb38b6a74",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    }
  },
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "price": 10000,
  "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"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateLocationRequest	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

UploadImge

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

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
}

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

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": "string",
  "state": "Missouri",
  "city": "St. Louis",
  "zipCode": "63102"
}

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

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": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string"
    }
  ],
  "ownerId": "string",
  "ownerEmail": "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
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

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": "string",
            "state": "Missouri",
            "city": "St. Louis",
            "zipCode": "63102"
          },
          "schedule": {
            "monday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "tuesday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "wednesday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "thursday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "friday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "saturday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            },
            "sunday": {
              "isOpen": true,
              "open": "09:00:00",
              "close": "17:00:00",
              "maxVisitors": 20
            }
          },
          "amenities": [
            "string"
          ],
          "price": 0,
          "pictureUrls": [
            "string"
          ],
          "phone": "string",
          "checkInInstructions": "string",
          "description": "string",
          "waiverUrl": "string",
          "termsOfSerivceUrl": "string"
        }
      ],
      "ownerId": "string",
      "ownerEmail": "string"
    }
  ],
  "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": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    }
  },
  "amenities": [
    "string"
  ],
  "price": 0,
  "pictureUrls": [
    "string"
  ],
  "phone": "string",
  "checkInInstructions": "string",
  "description": "string",
  "waiverUrl": "string",
  "termsOfSerivceUrl": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
address	Address	true	none	none
schedule	Schedule	true	none	none
amenities	[string]	true	none	none
price	integer(int64)	true	none	none
pictureUrls	[string]	true	none	none
phone	string	true	none	none
checkInInstructions	string	true	none	none
description	string¦null	false	none	none
waiverUrl	string	true	none	none
termsOfSerivceUrl	string	true	none	none

ApplicationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "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
ownerIds	[string]¦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

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

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": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    }
  },
  "price": 0,
  "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",
  "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

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": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        }
      },
      "price": 0,
      "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",
      "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

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"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	ApplicationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetLocationsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  },
  "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

GetUsersWithRoleRequest

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

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

GetWorkspacesRequest

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

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

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

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": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    }
  },
  "price": 0,
  "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"
}

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	none
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

LocationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "searchText": "The Zentrys",
  "geoSearch": {
    "maxMiles": 25,
    "latitude": 38.62,
    "longitude": -90.18
  }
}

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	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

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

Schedule

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

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": 20
}

Name	Type	Required	Restrictions	Description
isOpen	boolean	true	none	Flag indicating if the location is open on this day
open	string(date-span)	true	none	The time the location opens
close	string(date-span)	true	none	The time the location closes
maxVisitors	integer(int32)¦null	false	none	The maximum number of visitors allowed for the day. Default is unlimited.

SubmitApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

UpdateApplicationRequest

{
  "id": "string",
  "name": "string",
  "description": "string",
  "locations": [
    {
      "name": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "schedule": {
        "monday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "tuesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "wednesday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "thursday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "friday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "saturday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        },
        "sunday": {
          "isOpen": true,
          "open": "09:00:00",
          "close": "17:00:00",
          "maxVisitors": 20
        }
      },
      "amenities": [
        "string"
      ],
      "price": 0,
      "pictureUrls": [
        "string"
      ],
      "phone": "string",
      "checkInInstructions": "string",
      "description": "string",
      "waiverUrl": "string",
      "termsOfSerivceUrl": "string"
    }
  ]
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
locations	[ApplicationLocation]	true	none	none

UpdateLocationRequest

{
  "id": "686d3163ee1ffbbdb38b6a74",
  "name": "The Zentrys - St. Louis",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "schedule": {
    "monday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "tuesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "wednesday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "thursday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "friday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "saturday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    },
    "sunday": {
      "isOpen": true,
      "open": "09:00:00",
      "close": "17:00:00",
      "maxVisitors": 20
    }
  },
  "pictureUrls": [
    "https://example.com/photo1.jpg",
    "https://example.com/photo2.jpg"
  ],
  "amenities": [
    "Wi-Fi",
    "Pickleball"
  ],
  "price": 10000,
  "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"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	Zentry Pass Workspace Location Id
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
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

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

Workspace

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

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

WorkspaceIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "Zentry Pass",
      "email": "workspace@zentrypass.com"
    }
  ],
  "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