Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cadana Milestones API

APIs for milestone-based contractor pay

Cadana Milestones API is one of 30 APIs that Cadana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Milestones. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.cadanapay.com, https://dev-api.cadanapay.com.

5 operations 3 paths 9 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.cadanapay.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Cadana Milestones API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_SECRET_KEY) (Authorization). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Milestones 5

APIs for milestone-based contractor pay

GET
/v1/persons/{personId}/milestones
List milestones
getPersonMilestones 3 params → 2004004045XX
POST
/v1/persons/{personId}/milestones
Add milestone
addPersonMilestone 2 params body → 2004004045XX
PUT
/v1/persons/{personId}/milestones/{milestoneId}
Update milestone
updatePersonMilestone 3 params body → 2044004045XX
DELETE
/v1/persons/{personId}/milestones/{milestoneId}
Delete milestone
deletePersonMilestone 3 params → 2044004045XX
POST
/v1/persons/{personId}/milestones/{milestoneId}/complete
Complete milestone
completePersonMilestone 3 params → 2004004045XX

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Milestone (12 properties), AddMilestoneRequest (5 properties), UpdateMilestoneRequest (5 properties), amount (2 properties). Each schema is shown below with its type and property counts.

Milestone
object
12 properties
amount
object
2 properties 2 required
AddMilestoneRequest
object
5 properties 2 required
UpdateMilestoneRequest
object
5 properties 2 required
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
BadRequestError
Bad input provided by client
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-milestones-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

Cadana Balances API
Cadana Beneficiaries API
Cadana Businesses API
Cadana Contracts API
Cadana Custom Auth API
Cadana Entities API
Cadana Events API
Cadana Files API
Cadana Filings API
Cadana FX API
Cadana Instant Pay API
Cadana Invoices API