AlayaCare sequence outbox API
The sequence outbox API from AlayaCare — 1 operation(s) for sequence 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-sequence-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 sequence 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: sequence outbox
paths:
/v1/outbox/sequences:
get:
tags:
- sequence outbox
description: '# Authorization
Required role: `org_admin`
# Description
Get a paginated collection of sequences as a demand organization.
'
parameters:
- in: query
name: supply_persona_id
schema:
type: string
format: uuid
description: Filter sequences by supply organization ID.
required: false
- in: query
name: client_outbox_id
schema:
type: string
description: Filter sequences by client outbox ID.
required: false
- in: query
name: sequence_id
schema:
type: array
items:
type: string
format: uuid
maxItems: 100
description: Filter by specific sequence IDs.
required: false
- in: query
name: sort_by
schema:
type: string
enum:
- latest_message_created_at
default: latest_message_created_at
- $ref: '#/components/parameters/SortOrderParam'
- $ref: '#/components/parameters/PageNumberParam'
- $ref: '#/components/parameters/ItemsPerPageParam'
responses:
200:
description: Successfully retrieved paginated sequences.
content:
application/json:
schema:
$ref: '#/components/schemas/OutboxSequencePageResponse'
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:
DemographicLeanCore:
type: object
properties:
first_name:
type: string
minLength: 1
last_name:
type: string
minLength: 1
required:
- first_name
- last_name
SequenceLatestReferralResponse:
type: object
properties:
id:
type: string
format: uuid
required:
- id
ItemsPerPageCore:
type: integer
minimum: 1
default: 100
OutboxSequencePageResponse:
allOf:
- $ref: '#/components/schemas/PageCore'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/OutboxSequenceCollectionResponse'
required:
- items
SequenceClientResponse:
type: object
properties:
id:
type: string
format: uuid
outbox_id:
type: string
minLength: 1
demographics:
$ref: '#/components/schemas/DemographicLeanCore'
required:
- outbox_id
- demographics
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
OrganizationLeanCore:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
minLength: 1
required:
- id
- name
SequenceOfferResponse:
type: object
properties:
id:
type: string
format: uuid
required:
- id
PageNumberCore:
type: integer
minimum: 1
default: 1
OutboxSequenceCollectionResponse:
type: object
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
supply:
$ref: '#/components/schemas/OrganizationLeanCore'
client:
$ref: '#/components/schemas/SequenceClientResponse'
service:
$ref: '#/components/schemas/SequenceServiceResponse'
latest_referral:
$ref: '#/components/schemas/SequenceLatestReferralResponse'
offer:
$ref: '#/components/schemas/SequenceOfferResponse'
latest_message_created_at:
type: string
format: date-time
required:
- id
- created_at
- supply
- client
- service
SequenceServiceResponse:
type: object
properties:
outbox_id:
type: string
minLength: 1
name:
type: string
minLength: 1
required:
- name
- outbox_id
parameters:
PageNumberParam:
in: query
name: page
schema:
$ref: '#/components/schemas/PageNumberCore'
ItemsPerPageParam:
in: query
name: items_per_page
schema:
$ref: '#/components/schemas/ItemsPerPageCore'
SortOrderParam:
in: query
name: sort_order
schema:
$ref: '#/components/schemas/SortOrderCore'
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"}'