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/maintainx:maintainx-conversations-api"
All apis
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.
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:
description: 'REST API V1
Support: support@getmaintainx.com | https://www.getmaintainx.com/
This is the MaintainX REST API reference. It provides detailed documentation for endpoints, request parameters, response schemas, and error codes available.
For setup guides, authentication walkthroughs, how-tos, etc., see the Build With MaintainX guide.
What''s in this reference:
Full endpoint listings across all MaintainX entities (Work Orders, Assets, Parts, Locations, Users, and more)
Request and response schemas with field-level detail
Query parameters, filters, and pagination behavior
Authentication requirements and error codes
Subscriptions and webhooks for event-driven integrations
Base URL: https://api.getmaintainx.com/v1
All requests must be authenticated with a Bearer token (see Settings > Integrations > API Keys to generate a key).
API access is available on Premium and Enterprise plans.'
version: '1'
title: MaintainX Conversations API
contact:
url: https://www.getmaintainx.com/
name: Support
email: support@getmaintainx.com
x-logo:
url: https://maintainx-static.s3.us-west-2.amazonaws.com/logo/adsk-maintainx-logo.svg
backgroundColor: '#FFFFFF'
altText: MaintainX, an Autodesk company
servers:
- url: https://api.getmaintainx.com/v1
description: Endpoint
security:
- Bearer: []
tags:
- name: Conversations
description: Operations on Conversations
x-traitTag: false
paths:
/conversations:
get:
summary: List conversations
description: Endpoint used to list conversation resources
parameters:
- name: cursor
in: query
schema:
description: Last pagination reference
type: string
- name: limit
in: query
schema:
description: max number of Conversations returned
type: integer
minimum: 1
maximum: 200
default: 100
- name: type
schema:
type: array
items:
type: string
enum:
- GROUP
- DM
- TEAM
title: conversation type filters
description: 'To filter by multiple type: `type=GROUP&type=TEAM`'
in: query
- name: onlyNamed
schema:
type: boolean
description: Will only show named group conversations and team conversation
in: query
- schema:
type: integer
description: Required if using a multi organizations token
name: x-organization-id
in: header
required: false
example: '1'
responses:
'200':
description: Successfully fetched Conversations list
content:
application/json:
schema:
type: object
required:
- conversations
- nextCursor
- nextPageUrl
properties:
conversations:
type: array
items:
type: object
required:
- id
- type
properties:
id:
type: number
description: Global ID of the conversation
type:
type: string
description: Type of conversation
enum:
- GROUP
- DM
- TEAM
name:
type:
- string
- 'null'
description: Display name of the conversation
nextCursor:
description: The cursor to retrieve the next page of Conversations.
type:
- string
- 'null'
nextPageUrl:
description: Path with query parameters that can be used to retrieve the next page of Conversations.
type:
- string
- 'null'
'400':
description: Error with query
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
description: Description of error
type: string
'401':
$ref: '#/components/responses/UnauthorizedError'
tags:
- Conversations
operationId: getConversations
x-operation-id-source: derived
/conversations/{id}/members:
get:
summary: List conversation members
parameters:
- name: cursor
in: query
schema:
description: Last pagination reference
type: string
- name: limit
in: query
schema:
description: max number of Members returned
type: integer
minimum: 1
maximum: 200
default: 100
responses:
'200':
description: Successfully fetched Members list
content:
application/json:
schema:
type: object
required:
- members
- nextCursor
- nextPageUrl
properties:
members:
type: array
items:
type: object
required:
- id
- firstName
- lastName
properties:
id:
type: integer
example: 963
description: Global ID of the user
firstName:
type: string
example: John
lastName:
type: string
example: Doe
nextCursor:
description: The cursor to retrieve the next page of Members.
type:
- string
- 'null'
nextPageUrl:
description: Path with query parameters that can be used to retrieve the next page of Members.
type:
- string
- 'null'
'400':
description: Error with query
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
description: Description of error
type: string
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Cannot find the parent resource
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
description: Description of error
type: string
tags:
- Conversations
operationId: getConversationsByIdMembers
x-operation-id-source: derived
/conversations/{id}/messages:
post:
summary: Create new message in a conversation
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: ID of the conversation
example: '1'
- schema:
type: boolean
description: Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)
name: skipWebhook
in: query
required: false
requestBody:
description: Message to create
required: true
content:
application/json:
schema:
type: object
required:
- content
properties:
content:
type: string
description: Content of the message to post
responses:
'201':
description: Successfully created the message
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: number
description: Global ID of the message
'400':
description: Failed to create the message
content:
application/json:
schema:
type: object
required:
- errors
example:
errors:
- error: should have required property 'content'
fieldPath: content
properties:
errors:
type: array
items:
type: object
required:
- error
properties:
error:
type: string
fieldPath:
type:
- string
- 'null'
fieldValue:
oneOf:
- type: string
- type: number
- type: boolean
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Could not find the specified conversation.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
example: conversation Not Found
tags:
- Conversations
operationId: postConversationsByIdMessages
x-operation-id-source: derived
components:
responses:
UnauthorizedError:
description: Invalid token
securitySchemes:
Bearer:
description: "\n <p>Authenticate by adding the following HTTP header to your requests:</p>\n<pre>Authorization: bearer {{token}}</pre>\n<p>The <code>token</code> can be generated in your MaintainX account. Go to <a href=\"https://app.getmaintainx.com/settings/integrations/apiKeys\">\"Settings > Integrations > API Keys\"</a> to generate a key for your user.</p>\n"
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: MaintainX
source: https://api.getmaintainx.com/v1/openapi.json?v=26.10.1451-310524
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)