AlayaCare visit outbox API
The visit outbox API from AlayaCare — 2 operation(s) for visit outbox.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/alayacare-visit-outbox-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Alayacare visit outbox API
version: '1.0'
servers:
- url: https://api.{env}.alayamarket.{region}/offers
variables:
env:
description: The server environment.
enum:
- staging
- sandbox
- prod
default: prod
region:
description: The server top-level domain indicating the region.
enum:
- ca
- com
- com.au
default: ca
security:
- CognitoAuthorizer: []
tags:
- name: visit outbox
paths:
/v1/outbox/visits:
get:
tags:
- visit outbox
description: '# Authorization
Required role: demand `org_admin` who created the associated referral or service.
# Description
Get a collection of Visits for a given referral or service.
One of `referral_id`, `service_id`, or `service_outbox_id` must be provided.
'
parameters:
- $ref: '#/components/parameters/ReferralIdQueryParam'
- $ref: '#/components/parameters/ServiceIdQueryParam'
- in: query
name: service_outbox_id
schema:
type: string
description: ID of a service in the demand system.
required: false
- $ref: '#/components/parameters/PageNumberParam'
- $ref: '#/components/parameters/ItemsPerPageParam'
- in: query
name: sort_by
schema:
type: string
enum:
- last_modified
- start_at
default: start_at
- $ref: '#/components/parameters/SortOrderParam'
responses:
200:
description: Successfully retrieved a collection of Visits.
content:
application/json:
schema:
$ref: '#/components/schemas/OutboxVisitPageResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
/v1/outbox/visits/{visit_id}:
get:
tags:
- visit outbox
description: '# Authorization
Required role: demand `org_admin` who created the associated referral or service.
# Description
Get the details of a Visit for a given Visit ID.
'
parameters:
- $ref: '#/components/parameters/VisitIdPathParam'
responses:
200:
description: Successfully retrieved a Visit.
content:
application/json:
schema:
$ref: '#/components/schemas/OutboxVisitDetailResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
components:
schemas:
VisitCore:
type: object
properties:
id:
type: string
format: uuid
referral_id:
type: string
format: uuid
service_id:
type: string
format: uuid
status:
type: string
enum:
- scheduled
- deleted
- cancelled
- on_hold
start_at:
type: string
format: date-time
end_at:
type: string
format: date-time
required:
- status
- id
- referral_id
- service_id
- start_at
- end_at
ItemsPerPageCore:
type: integer
minimum: 1
default: 100
OutboxVisitCore:
allOf:
- $ref: '#/components/schemas/VisitCore'
- type: object
properties:
visit_outbox_id:
type: string
service_outbox_id:
type: string
minLength: 1
required:
- service_outbox_id
OutboxVisitDetailResponse:
type: object
properties:
visit:
title: OutboxVisitDetailCore
allOf:
- $ref: '#/components/schemas/OutboxVisitCore'
- properties:
verified_start_at:
type: string
format: date-time
verified_end_at:
type: string
format: date-time
supply:
title: OutboxVisitDetailSupplyResponse
properties:
id:
type: string
format: uuid
required:
- id
supply_employee:
title: OutboxVisitDetailSupplyEmployeeResponse
type: object
properties:
id:
type: string
format: uuid
supply_persona_id:
type: string
format: uuid
ssn_placeholder:
type: string
first_name:
type: string
last_name:
type: string
date_of_birth:
type: string
format: date
data:
type: object
required:
- id
- supply_persona_id
- ssn_placeholder
- first_name
- last_name
tasks:
type: array
items:
title: OutboxVisitDetailVisitTaskResponse
type: object
properties:
id:
type: string
format: uuid
outbox_id:
type: string
is_completed:
type: boolean
completed_at:
type: string
format: date-time
completion_comment:
type: string
required:
- id
- is_completed
required:
- supply
- visit
- tasks
PageCore:
description: Root page schema for returning collections.
type: object
properties:
page:
$ref: '#/components/schemas/PageNumberCore'
items_per_page:
$ref: '#/components/schemas/ItemsPerPageCore'
total_items:
type: integer
minimum: 0
total_pages:
type: integer
minimum: 0
required:
- page
- items_per_page
- total_items
- total_pages
SortOrderCore:
type: string
enum:
- asc
- desc
default: desc
OutboxVisitCollectionResponse:
allOf:
- $ref: '#/components/schemas/OutboxVisitCore'
PageNumberCore:
type: integer
minimum: 1
default: 1
OutboxVisitPageResponse:
allOf:
- $ref: '#/components/schemas/PageCore'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/OutboxVisitCollectionResponse'
parameters:
ReferralIdQueryParam:
in: query
name: referral_id
schema:
type: string
format: uuid
PageNumberParam:
in: query
name: page
schema:
$ref: '#/components/schemas/PageNumberCore'
ItemsPerPageParam:
in: query
name: items_per_page
schema:
$ref: '#/components/schemas/ItemsPerPageCore'
VisitIdPathParam:
in: path
name: visit_id
schema:
type: string
format: uuid
required: true
description: ID of a visit.
SortOrderParam:
in: query
name: sort_order
schema:
$ref: '#/components/schemas/SortOrderCore'
ServiceIdQueryParam:
in: query
name: service_id
schema:
type: string
format: uuid
securitySchemes:
CognitoAuthorizer:
type: apiKey
name: Authorization
in: header
x-amazon-apigateway-authtype: cognito_user_pools
x-amazon-apigateway-authorizer:
type: cognito_user_pools
providerARNs:
- Fn::Sub: '{{resolve:ssm:/${StackName}/${UserPoolArnSSMParameterName}}}'
x-amazon-apigateway-request-validators:
body:
validateRequestBody: true
validateRequestParameters: false
params:
validateRequestBody: false
validateRequestParameters: true
params-and-body:
validateRequestBody: true
validateRequestParameters: true
x-amazon-apigateway-request-validator: params
x-amazon-apigateway-gateway-responses:
BAD_REQUEST_BODY:
statusCode: 400
responseTemplates:
application/json: '{"message": $context.error.messageString, "description": "$context.error.validationErrorString"}'