AlayaCare Forms API
The Forms API from AlayaCare — 1 operation(s) for forms.
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-forms-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 Forms API
version: '1.0'
description: 'Operations tagged Forms across 2 of this provider''s published API definitions: alayacare-careplan-openapi.yml, alayacare-tasks-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://homecare.alayacare.ca/ext/api/v2/clinical
- url: https://homecare.alayacare.ca/ext/api/v2/tasks
tags:
- name: Forms
paths:
/forms:
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/count'
- description: Search for a form using the form name. This will return all forms containing the search string.
name: filter
in: query
schema:
type: string
- description: Filter by branch ID.
name: branch_id
in: query
required: false
schema:
type: integer
get:
tags:
- Forms
summary: Get a list of report forms to attach to an intervention
description: '- Only forms that the current user can view will be returned.
- Disabled forms will be excluded.
- Results are ordered alphabetically by the form description.'
responses:
200:
description: A list of report forms
content:
application/json:
schema:
$ref: '#/components/schemas/FormList'
401:
$ref: '#/components/responses/AuthChallenge'
403:
$ref: '#/components/responses/ErrorInsufficientAccess'
404:
$ref: '#/components/responses/ErrorResponseFormNotFound'
operationId: getForms
x-operation-id-source: derived
servers:
- url: https://homecare.alayacare.ca/ext/api/v2/clinical
components:
parameters:
count:
description: Number of items per page.
name: count
in: query
required: false
schema:
type: integer
default: 100
page:
description: Filter by page number.
name: page
in: query
required: false
schema:
type: integer
default: 1
count_2:
name: count
in: query
required: false
description: Number of items per page. If not specified will default to 100.
schema:
type: integer
default: 100
page_2:
name: page
in: query
required: false
description: Filter by page number. If not specified will default to 1.
schema:
type: integer
default: 1
schemas:
FormList:
required:
- count
- page
- total_pages
- items
type: object
properties:
count:
type: integer
description: Number of items in the response
example: null
page:
type: integer
description: Current page number
example: 1
total_pages:
type: integer
description: Total number of pages available
example: 1
items:
type: array
items:
$ref: '#/components/schemas/Form'
ErrorResponse:
description: Error response
type: object
properties:
status_code:
type: integer
description: Response code
message:
type: string
description: Detailed error message
required:
- code
- message
Form:
type: object
required:
- id
- name
properties:
id:
type: integer
description: Report form ID of the task.
example: 1604
name:
type: string
description: 'Name of the report form. Limited to 256 chars.
'
example: New Client Assessment
branch:
$ref: '#/components/schemas/Branch'
Branch:
description: AlayaCare Branch
type: object
properties:
id:
type: integer
description: Branch ID
example: 1000
name:
type: string
description: Branch name
example: AlayaCare Health
ErrorResponse_2:
description: Error response
type: object
properties:
code:
type: integer
description: Response code
message:
type: string
description: Detailed error message
required:
- code
- message
Form_2:
type: object
required:
- id
- name
properties:
id:
type: integer
description: Report form ID of the task.
example: 1604
name:
type: string
description: 'Name of the report form. Limited to 256 chars.
'
example: New Client Assessment
dispatch_fields:
type: array
description: The dispatch fields associated to the report form.
items:
$ref: '#/components/schemas/FormField'
branch:
$ref: '#/components/schemas/Branch'
FormField:
type: object
required:
- id
- name
properties:
id:
type: integer
description: The form field identifier.
example: 1234
name:
type: string
description: The form field identifier.
example: field_1234
label:
type: string
description: The form field label.
example: Enter the client pain levels.
type:
type: string
description: The form field type. This should exclude any types associated to file uploads (e.g. `picture`, `signature`, etc).
example: list
list:
type: array
description: A list of options if the form field type is `list` or `ist_multiple`.
items:
type: string
example: Moderate pain
responses:
AuthChallenge:
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 401
message: Please verify your access level for this url.
ErrorInsufficientAccess:
description: You do not have the required permissions to perform this action
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 403
message: Access required
ErrorResponseFormNotFound:
description: Form not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 404
message: Form not found
AuthChallenge_2:
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
example:
code: 401
message: Please verify your access level for this url.
securitySchemes:
basic_auth:
type: http
scheme: basic
description: Basic HTTP auth over https
x-refined-from:
- alayacare-careplan-openapi.yml
- alayacare-tasks-openapi.yml