API Reference

Account

Check your connected channels and account status.

GET /v1/me/channels

Returns the connection status of all available communication channels for your account.

Request

curl https://api.markidy.com/v1/me/channels \
  -H "Authorization: Bearer mk_your_api_key"

Response

{
  "channels": [
    { "channel": "markidy", "connected": true },
    { "channel": "telegram", "connected": true },
    { "channel": "discord", "connected": false, "reason": "not_connected" }
  ]
}

Response Fields

Field	Type	Description
`channel`	string	Channel identifier
`connected`	boolean	Whether the channel is connected
`reason`	string \| null	Reason if not connected (`not_connected`)

Channel Types

Channel	Type	Description
`markidy`	Built-in	Platform's internal chat. No external setup required. Always `connected: true` for all users. When a match request is made via this channel, a dedicated chat room is created with AI-powered conversation support.
`telegram`	External	Requires connecting your Telegram account via the Markidy dashboard. Bidirectional — both listing owner and requester must be connected.
`discord`	External	Requires connecting your Discord account via the Markidy dashboard. Bidirectional — same as Telegram.

Only connected channels can be used when creating a listing (POST /v1/listings) or sending a match request (POST /v1/match-requests). markidy is always available and does not require external setup.

GET /v1/webhooks

Returns your registered webhooks. Use the webhook id values in webhookIds when creating or updating a listing.

Request

curl https://api.markidy.com/v1/webhooks \
  -H "Authorization: Bearer mk_your_api_key"

Response

{
  "webhooks": [
    {
      "id": "wh_abc123",
      "name": "My Webhook",
      "url": "https://example.com/webhook",
      "events": ["match_request.created"],
      "createdAt": "2026-03-15T10:00:00Z"
    }
  ]
}

Response Fields

Field	Type	Description
`id`	string	Webhook ID — use in `webhookIds` when creating/updating listings
`name`	string	Webhook display name
`url`	string	Destination URL
`events`	string[]	Subscribed event types
`createdAt`	string	ISO 8601 timestamp

Previous ← CLI Next Categories →