{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:slmonitor/api-get-user":{"get":{"operationId":"business_slmonitor_api_get_user","summary":"Get the authenticated user","description":"GET /api/v2.1/companies/{companyId}/me","tags":["business"],"parameters":[{"name":"companyId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-get-users":{"get":{"operationId":"business_slmonitor_api_get_users","summary":"Get all the users","description":"GET /api/v2.1/companies/{companyId}/users","tags":["business"],"parameters":[{"name":"companyId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-get-user2":{"get":{"operationId":"business_slmonitor_api_get_user2","summary":"Get the user's profile","description":"GET /api/v2.1/companies/{companyId}/users/{uniqueUserId}","tags":["business"],"parameters":[{"name":"uniqueUserId","in":"query","required":true,"description":"The unique user id","schema":{"type":"string","description":"The unique user id"}},{"name":"companyId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-check-in":{"post":{"operationId":"business_slmonitor_api_check_in","summary":"Check in","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/checkin","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"interval":{"type":"integer","description":"The optional check-in interval in minutes"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-check-in-with-audio":{"post":{"operationId":"business_slmonitor_api_check_in_with_audio","summary":"Check in with an audio recording","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/checkin-audio","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string"},"interval":{"type":"integer","description":"The optional check-in interval in minutes"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-check-in-with-text":{"post":{"operationId":"business_slmonitor_api_check_in_with_text","summary":"Check in with a text report","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/checkin-text","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"interval":{"type":"integer","description":"The optional check-in interval in minutes"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-emergency":{"post":{"operationId":"business_slmonitor_api_emergency","summary":"Declare an emergency","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/emergency","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-emergency-with-audio":{"post":{"operationId":"business_slmonitor_api_emergency_with_audio","summary":"Declare an emergency with an audio recording","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/emergency-audio","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-emergency-with-text":{"post":{"operationId":"business_slmonitor_api_emergency_with_text","summary":"Declare an emergency with a text report","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/emergency-text","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-end":{"post":{"operationId":"business_slmonitor_api_end","summary":"End monitoring","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/end","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-end-with-audio":{"post":{"operationId":"business_slmonitor_api_end_with_audio","summary":"End monitoring with an audio recording","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/end-audio","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-end-with-text":{"post":{"operationId":"business_slmonitor_api_end_with_text","summary":"End monitoring with a text report","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/end-text","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-update-itinerary":{"post":{"operationId":"business_slmonitor_api_update_itinerary","summary":"Update the itinerary","description":"PUT /api/v2.1/companies/{companyId}/users/{uniqueUserId}/itinerary","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-update-itinerary-file":{"post":{"operationId":"business_slmonitor_api_update_itinerary_file","summary":"Update the itinerary file","description":"PUT /api/v2.1/companies/{companyId}/users/{uniqueUserId}/itinerary-file","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"companyId":{"type":"string"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-report-location":{"post":{"operationId":"business_slmonitor_api_report_location","summary":"Report a location","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/location","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:slmonitor/api-report-text":{"post":{"operationId":"business_slmonitor_api_report_text","summary":"Send a text message","description":"POST /api/v2.1/companies/{companyId}/users/{uniqueUserId}/text","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueUserId","companyId","body"],"properties":{"uniqueUserId":{"type":"string","description":"The unique user id"},"deviceType":{"type":"integer","enum":[1,2,3,4,5,10,11],"default":10,"description":"Optional, the device type performing the command."},"companyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}