Conduyt Status Metadata API
The Status Metadata API from Conduyt — 7 operation(s) for status metadata.
The Status Metadata API from Conduyt — 7 operation(s) for status metadata.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/conduyt-com:conduyt-com-status-metadata-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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: 3.2.0
info:
title: Conduyt Status Metadata API
version: 1.0.0
description: 'The Conduyt CRM API provides programmatic access to your CRM data including
contacts, companies, deals, pipelines, tasks, notes, automations, invoices,
email sequences, and more.
## Authentication
All authenticated endpoints require a Bearer token (API key) in the
`Authorization` header:
```
Authorization: Bearer cdy_
```
API keys are generated in **Settings > API Keys** within the Conduyt
dashboard. Keys use the `cdy_` prefix and are hashed with bcrypt on
creation — the full key is shown exactly once at creation time.
Session cookie authentication (`conduyt_session`) is also supported for
browser-based clients but is not recommended for integrations.
## Rate Limiting
API keys enforce a per-key rate limit. New keys default to 100 requests per
minute and can be configured at creation time or with PATCH `/api-keys/{id}`.
Some public and provider-facing endpoints also enforce stricter per-IP or
per-account limits. When exceeded, the API returns `429 Too Many Requests`
with a `Retry-After` header indicating seconds until the next allowed
request.
| Endpoint Group | Limit |
|---------------------|---------------------|
| API keys | Default 100 / min per key |
| Login/reset | 5 / min per IP |
| Registration | 3 / hour per IP |
| Contact/Deal create | 30 / min per IP |
| Inbound messages | 120 / min per account/IP |
## Pagination
List endpoints support cursor-based pagination via query parameters:
- `page` — Page number (default: 1)
- `per_page` — Items per page (default: 50, max: 200)
- `limit` — Accepted as an alias of `per_page` on `GET /contacts`; if both are
sent they must carry the same value.
A page size above the maximum, a non-integer, a value below 1, or a
pagination key repeated with different values is rejected with `400`
(the message names the parameter and the rule); nothing is silently
clamped or ignored.
Responses include a `meta` object: `{ page, per_page, total }`.
An operation that documents its own pagination rules follows those instead.
`GET /sms-providers/options` pages with an opaque `cursor` and a `limit`
that is capped at 50 rather than rejected; its responses carry
`meta: { nextCursor, truncated }`.
## Response Format
All successful responses wrap data in a `data` envelope:
```json
{ "data": { ... } }
```
Error responses use:
```json
{ "error": "Human-readable error message" }
```
## Multi-Tenancy
Conduyt is multi-tenant. All data is scoped to the authenticated user''s
current account. API keys are bound to a specific account at creation time.
## Webhook Events
Outbound webhooks fire on events including:
`contact.created`, `contact.updated`, `contact.deleted`,
`deal.created`, `deal.updated`, `deal.won`, `deal.lost`,
`task.created`, `task.completed`, `note.created`,
`appointment.created`, `appointment.updated`,
`form.submitted`, `invoice.paid`
Payloads are signed with HMAC-SHA256 using the webhook''s secret. Retry
schedule: 1m, 5m, 30m, 2h, 12h, 72h (7 total attempts including the initial delivery).'
contact:
name: Conduyt Support
url: https://conduyt.app
email: support@conduyt.app
license:
name: Proprietary
url: https://conduyt.app/terms
servers:
- url: https://conduyt.app/api/v1
description: Production
security:
- BearerAuth: []
tags:
- name: Status Metadata
paths:
/status-metadata/{id}:
delete:
operationId: deleteStatusMetadataId
summary: Delete status-metadata id
tags:
- Status Metadata
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: dry_run
in: query
required: false
description: Validate the mutation without persisting changes.
schema:
type: boolean
- name: expected_updated_at
in: query
required: false
description: 'The row''s updatedAt as the caller read it: a row changed or moved since is a 409 metadata_changed (the settings page always sends it). Without it, only a move under this request is caught.'
schema:
type: string
format: date-time
- name: sandbox
in: query
required: false
description: Run the mutation in sandbox mode.
schema:
type: boolean
responses:
'204':
description: Deleted
'404':
description: 'status_metadata_not_found: no status metadata with this id that you can see (a malformed id, an unknown or hidden one, or one deleted while this request waited). Nothing deleted.'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- status_metadata_not_found
'409':
description: 'pipeline_archived: the stage''s pipeline was archived while this request waited on its stage lock ("This pipeline was archived meanwhile."); metadata_changed: the row is not the version the caller named in expectedUpdatedAt (or it moved to another stage under the request); `current` is the row now. Nothing written.'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- pipeline_archived
- metadata_changed
current:
type: object
description: 'With metadata_changed: the row as it is now (the version to retry against is its updatedAt)'
get:
x-generated: true
operationId: getStatusMetadataId
summary: Get status-metadata id
tags:
- Status Metadata
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
patch:
operationId: patchStatusMetadataId
summary: Update status-metadata id
tags:
- Status Metadata
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: dry_run
in: query
required: false
description: Validate the mutation without persisting changes.
schema:
type: boolean
- name: sandbox
in: query
required: false
description: Run the mutation in sandbox mode.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
expectedUpdatedAt:
type: string
format: date-time
description: 'The row''s updatedAt as the caller read it: a row changed or moved since is a 409 metadata_changed (the settings page always sends it). Without it, only a move under this request is caught.'
bucket:
description: Read by the handler from the JSON body (the route declares no schema for its type).
code:
description: Read by the handler from the JSON body (the route declares no schema for its type).
dripEligible:
description: Read by the handler from the JSON body (the route declares no schema for its type).
dripTrackId:
description: Read by the handler from the JSON body (the route declares no schema for its type).
expected_updated_at:
description: Read by the handler from the JSON body (the route declares no schema for its type).
isTerminal:
description: Read by the handler from the JSON body (the route declares no schema for its type).
lifecycleStage:
description: Read by the handler from the JSON body (the route declares no schema for its type).
notes:
description: Read by the handler from the JSON body (the route declares no schema for its type).
stageId:
description: Read by the handler from the JSON body (the route declares no schema for its type).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
'404':
description: 'status_metadata_not_found: no status metadata with this id that you can see (a malformed id, an unknown or hidden one, or one deleted while this request waited); stage_not_found: the stage named (stage_id) does not exist in this account, or was deleted while this request waited; drip_track_not_found: likewise for drip_track_id. Nothing written.'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- stage_not_found
- drip_track_not_found
- status_metadata_not_found
'409':
description: 'pipeline_archived: the stage''s pipeline was archived while this request waited on its stage lock ("This pipeline was archived meanwhile."); metadata_changed: the row is not the version the caller named in expectedUpdatedAt (or it moved to another stage under the request); `current` is the row now. Nothing written.'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- pipeline_archived
- metadata_changed
current:
type: object
description: 'With metadata_changed: the row as it is now (the version to retry against is its updatedAt)'
/status-metadata/buckets:
get:
x-generated: true
operationId: getStatusMetadataBuckets
summary: List status-metadata buckets
tags:
- Status Metadata
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
/status-metadata/by-stage/{stageId}:
get:
x-generated: true
operationId: getStatusMetadataByStageStageId
summary: Get status-metadata by-stage stageId
tags:
- Status Metadata
parameters:
- name: stageId
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
/status-metadata/decisions:
get:
x-generated: true
operationId: getStatusMetadataDecisions
summary: List status-metadata decisions
tags:
- Status Metadata
parameters:
- name: action
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: limit
in: query
required: false
description: Query parameter read by this route.
schema:
type: integer
default: 50
minimum: 1
maximum: 100
x-default-provenance: handler_literal
- name: since
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: stage_id
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: stageId
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: track_id
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: trackId
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
items: {}
summary: {}
meta: {}
required:
- items
- summary
- meta
required:
- data
/status-metadata/dry-run:
post:
x-generated: true
operationId: postStatusMetadataDryRun
summary: Create / invoke status-metadata dry-run
tags:
- Status Metadata
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- contactId
- dealId
- targetStageId
properties:
contactId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
dealId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
targetStageId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
decision: {}
reason: {}
currentState: {}
wouldBecome: {}
targetStage: {}
deal: {}
contact: {}
statusMetadata: {}
warnings: {}
required:
- decision
- reason
- currentState
- wouldBecome
- targetStage
- deal
- contact
- statusMetadata
- warnings
required:
- data
/status-metadata/import:
post:
operationId: postStatusMetadataImport
summary: Create / invoke status-metadata import
tags:
- Status Metadata
parameters:
- name: dry_run
in: query
required: false
description: Validate the mutation without persisting changes.
schema:
type: boolean
- name: sandbox
in: query
required: false
description: Run the mutation in sandbox mode.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- items
properties:
mode:
default: merge
type: string
enum:
- merge
- replace
items:
maxItems: 1000
type: array
items:
type: object
properties:
stageId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code:
type: string
pattern: ^[a-z0-9][a-z0-9_]{0,79}$
bucket:
type: string
pattern: ^[a-z0-9][a-z0-9_]{0,79}$
lifecycleStage:
anyOf:
- type: string
enum:
- pre_sale
- sale
- underwriting
- active
- resolution
- terminal
- type: 'null'
dripEligible:
default: false
type: boolean
dripTrackName:
anyOf:
- type: string
pattern: ^[a-z0-9][a-z0-9_]{0,79}$
- type: 'null'
isTerminal:
default: false
type: boolean
notes:
anyOf:
- type: string
maxLength: 5000
- type: 'null'
required:
- stageId
- code
- bucket
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
imported:
type: number
skipped:
type: number
errors:
type: array
required:
- imported
- skipped
- errors
required:
- data
'409':
description: 'pipeline_archived: an incoming stage belongs to an archived pipeline; `stageIds` lists them. Nothing imported. (A replace keeps the archived pipelines'' rows and replaces only the active pipelines'' rows.)'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- pipeline_archived
stageIds:
type: array
items:
type: string
format: uuid
/status-metadata:
get:
x-generated: true
operationId: getStatusMetadata
summary: List status-metadata
tags:
- Status Metadata
parameters:
- name: bucket
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: code
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: stage_id
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
- name: stageId
in: query
required: false
description: Query parameter read by this route.
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
post:
operationId: postStatusMetadata
summary: Create / invoke status-metadata
tags:
- Status Metadata
parameters:
- name: dry_run
in: query
required: false
description: Validate the mutation without persisting changes.
schema:
type: boolean
- name: sandbox
in: query
required: false
description: Run the mutation in sandbox mode.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
bucket:
description: Read by the handler from the JSON body (the route declares no schema for its type).
code:
description: Read by the handler from the JSON body (the route declares no schema for its type).
dripEligible:
description: Read by the handler from the JSON body (the route declares no schema for its type).
dripTrackId:
description: Read by the handler from the JSON body (the route declares no schema for its type).
isTerminal:
description: Read by the handler from the JSON body (the route declares no schema for its type).
lifecycleStage:
description: Read by the handler from the JSON body (the route declares no schema for its type).
notes:
description: Read by the handler from the JSON body (the route declares no schema for its type).
stageId:
description: Read by the handler from the JSON body (the route declares no schema for its type).
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/DataEnvelope'
'404':
description: 'stage_not_found: the stage named (stage_id) does not exist in this account, or was deleted while this request waited; drip_track_not_found: likewise for drip_track_id. Nothing written.'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- stage_not_found
- drip_track_not_found
'409':
description: 'pipeline_archived: the stage''s pipeline was archived while this request waited on its stage lock ("This pipeline was archived meanwhile."), nothing written'
content:
application/json:
schema:
type: object
required:
- error
- code
properties:
error:
type: string
code:
type: string
enum:
- pipeline_archived
current:
type: object
description: 'With metadata_changed: the row as it is now (the version to retry against is its updatedAt)'
components:
schemas:
DataEnvelope:
type: object
properties:
data:
description: Response payload (shape varies by endpoint)
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'API key authentication. Generate keys in Settings > API Keys.
Keys use the `cdy_` prefix.
Example: `Authorization: Bearer cdy_a1b2c3d4e5f6...`
'
x-mcp:
transport:
- stdio
- http
orchestration: code
endpoint_tools: hidden