Contraforce · Schema
PaginatedApiResponseOfServiceTicketResponse
Standard v2 API response envelope for paginated list responses.
SecuritySoftware-as-a-ServiceCybersecurityMicrosoftMSP
Properties
| Name | Type | Description |
|---|---|---|
| data | nullarray | |
| pagination | object | |
| meta | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/contraforce/json-schema/contraforce-paginated-api-response-of-service-ticket-response-schema.json",
"title": "PaginatedApiResponseOfServiceTicketResponse",
"description": "Standard v2 API response envelope for paginated list responses.",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/contraforce-service-tickets-api-openapi.yml#/components/schemas/PaginatedApiResponseOfServiceTicketResponse",
"type": "object",
"properties": {
"data": {
"type": [
"null",
"array"
],
"items": {
"description": "v2 view of an incident's service ticket in the workspace's connected ticketing system.",
"$ref": "#/$defs/ServiceTicketResponse"
}
},
"pagination": {
"$ref": "#/$defs/PaginationInfo"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"$defs": {
"AutotaskTicketNoteResponse": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask note id.",
"format": "int32"
},
"description": {
"type": [
"null",
"string"
],
"description": "Note text."
},
"ticketId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Ticket the note belongs to.",
"format": "int32"
},
"title": {
"type": [
"null",
"string"
],
"description": "Note title."
}
},
"description": "v2 view of a note on an Autotask ticket."
},
"AutotaskTicketResponse": {
"type": "object",
"properties": {
"id": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask ticket id.",
"format": "int32"
},
"companyId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask company the ticket belongs to.",
"format": "int32"
},
"projectId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"description": "Autotask project the ticket belongs to, if any.",
"format": "int32"
},
"assignedResourceId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"description": "Resource the ticket is assigned to, if any.",
"format": "int64"
},
"assignedResourceRoleId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"description": "Role of the assigned resource, if any.",
"format": "int64"
},
"billingCodeId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"description": "Billing code, if any.",
"format": "int32"
},
"categoryId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Ticket category id.",
"format": "int32"
},
"number": {
"type": [
"null",
"string"
],
"description": "Ticket number as Autotask shows it."
},
"type": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask ticket type id.",
"format": "int32"
},
"title": {
"type": [
"null",
"string"
],
"description": "Ticket title."
},
"description": {
"type": [
"null",
"string"
],
"description": "Ticket description."
},
"priority": {
"description": "Ticket priority.",
"$ref": "#/$defs/ServiceTicketAutotaskPriority"
},
"status": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask status id.",
"format": "int32"
},
"queueId": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"description": "Autotask queue id.",
"format": "int32"
},
"dueDateTime": {
"type": "string",
"description": "When the ticket is due.",
"format": "date-time"
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"description": "v2 view of a note on an Autotask ticket.",
"$ref": "#/$defs/AutotaskTicketNoteResponse"
},
"description": "Notes on the ticket; null when they were not loaded."
}
},
"description": "v2 view of an Autotask ticket."
},
"JiraIssueTypeResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Issue type id."
},
"name": {
"type": [
"null",
"string"
],
"description": "Issue type name."
},
"projectId": {
"type": [
"null",
"string"
],
"description": "Project the issue type belongs to."
},
"subtask": {
"type": "boolean",
"description": "Whether the issue type is a subtask type."
}
},
"description": "v2 view of a Jira issue type."
},
"JiraPriorityResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Priority id."
},
"name": {
"type": [
"null",
"string"
],
"description": "Priority name."
}
},
"description": "v2 view of a Jira priority."
},
"JiraProjectResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Project id."
},
"name": {
"type": [
"null",
"string"
],
"description": "Project name."
},
"key": {
"type": [
"null",
"string"
],
"description": "Project key."
}
},
"description": "v2 view of a Jira Service Management project."
},
"JiraRequestTypeResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Request type id."
},
"name": {
"type": [
"null",
"string"
],
"description": "Request type name."
}
},
"description": "v2 view of a Jira Service Management request type."
},
"JiraStatusResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Status id."
},
"name": {
"type": [
"null",
"string"
],
"description": "Status name."
}
},
"description": "v2 view of a Jira issue status."
},
"JiraTicketResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Jira issue id."
},
"description": {
"type": [
"null",
"string"
],
"description": "Issue description."
},
"summary": {
"type": [
"null",
"string"
],
"description": "Issue summary."
},
"number": {
"type": [
"null",
"string"
],
"description": "Issue key as Jira shows it."
},
"currentStatus": {
"description": "Current issue status.",
"$ref": "#/$defs/JiraStatusResponse"
},
"priority": {
"description": "Issue priority.",
"$ref": "#/$defs/JiraPriorityResponse"
},
"assignee": {
"description": "User the issue is assigned to, if any.",
"$ref": "#/$defs/JiraUserResponse"
},
"project": {
"description": "Service desk project the issue belongs to.",
"$ref": "#/$defs/JiraProjectResponse"
},
"issueType": {
"description": "Issue type.",
"$ref": "#/$defs/JiraIssueTypeResponse"
},
"requestType": {
"description": "Service desk request type.",
"$ref": "#/$defs/JiraRequestTypeResponse"
},
"labels": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "Issue labels."
},
"availablePriorities": {
"type": [
"null",
"array"
],
"items": {
"description": "v2 view of a Jira priority.",
"$ref": "#/$defs/JiraPriorityResponse"
},
"description": "Priorities the issue can be set to."
},
"availableStatuses": {
"type": [
"null",
"array"
],
"items": {
"description": "v2 view of a Jira issue status.",
"$ref": "#/$defs/JiraStatusResponse"
},
"description": "Statuses the issue can move to from its current status."
}
},
"description": "v2 view of a Jira Service Management issue linked as a ticket."
},
"JiraUserResponse": {
"type": "object",
"properties": {
"accountId": {
"type": [
"null",
"string"
],
"description": "Atlassian account id."
},
"displayName": {
"type": [
"null",
"string"
],
"description": "Display name."
},
"active": {
"type": "boolean",
"description": "Whether the account is active."
}
},
"description": "v2 view of a Jira user."
},
"PaginationInfo": {
"type": "object",
"properties": {
"continuationToken": {
"type": [
"null",
"string"
]
},
"hasMore": {
"type": "boolean"
}
}
},
"ResponseMeta": {
"type": "object",
"properties": {
"requestId": {
"type": [
"null",
"string"
]
},
"timestamp": {
"type": [
"null",
"string"
]
}
}
},
"ServiceNowTicketCommentResponse": {
"type": "object",
"properties": {
"sysId": {
"type": [
"null",
"string"
],
"description": "ServiceNow journal entry sys_id."
},
"elementId": {
"type": [
"null",
"string"
],
"description": "sys_id of the record the comment belongs to."
},
"value": {
"type": [
"null",
"string"
],
"description": "Comment text."
},
"createdOn": {
"type": "string",
"description": "When the comment was created.",
"format": "date-time"
},
"createdBy": {
"type": [
"null",
"string"
],
"description": "ServiceNow user who created the comment."
},
"element": {
"type": [
"null",
"string"
],
"description": "Journal field the comment was written to."
}
},
"description": "v2 view of a comment on a ServiceNow incident."
},
"ServiceNowTicketResponse": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "ServiceNow record sys_id."
},
"description": {
"type": [
"null",
"string"
],
"description": "Incident description."
},
"shortDescription": {
"type": [
"null",
"string"
],
"description": "Incident short description."
},
"number": {
"type": [
"null",
"string"
],
"description": "Incident number as ServiceNow shows it."
},
"state": {
"description": "Incident state.",
"$ref": "#/$defs/ServiceTicketServiceNowState"
},
"urgency": {
"description": "Incident urgency.",
"$ref": "#/$defs/ServiceTicketServiceNowUrgency"
},
"comments": {
"type": [
"null",
"array"
],
"items": {
"description": "v2 view of a comment on a ServiceNow incident.",
"$ref": "#/$defs/ServiceNowTicketCommentResponse"
},
"description": "Comments on the incident; null when they were not loaded."
}
},
"description": "v2 view of a ServiceNow incident linked as a ticket."
},
"ServiceTicketAutotaskPriority": {
"enum": [
"High",
"Medium",
"Low",
"Critical"
],
"description": "Autotask ticket priorities in the v2 service-ticket contract."
},
"ServiceTicketProvider": {
"enum": [
"Autotask",
"ServiceNow",
"Jira",
"Zendesk",
"None"
],
"description": "Ticketing systems in the v2 service-ticket contract."
},
"ServiceTicketResponse": {
"type": "object",
"properties": {
"autotaskTicket": {
"description": "The linked Autotask ticket; null unless the workspace uses Autotask and a ticket was returned.",
"$ref": "#/$defs/AutotaskTicketResponse"
},
"serviceNowTicket": {
"description": "The linked ServiceNow incident; null unless the workspace uses ServiceNow and a ticket was returned.",
"$ref": "#/$defs/ServiceNowTicketResponse"
},
"jiraTicket": {
"description": "The linked Jira Service Management issue; null unless the workspace uses Jira and a ticket was returned.",
"$ref": "#/$defs/JiraTicketResponse"
},
"ticketingSystemType": {
"description": "The ticketing system the workspace is connected to.",
"$ref": "#/$defs/ServiceTicketProvider"
},
"isTicketSet": {
"type": "boolean",
"description": "Whether a ticket was returned."
},
"unavailableTicketId": {
"type": [
"null",
"string"
],
"description": "Provider id of the incident's linked ticket when the provider no longer returns it; otherwise null."
},
"isTicketUnavailable": {
"type": "boolean",
"description": "Whether the incident is linked to a ticket the provider no longer returns."
}
},
"description": "v2 view of an incident's service ticket in the workspace's connected ticketing system."
},
"ServiceTicketServiceNowState": {
"enum": [
"New",
"InProgress",
"OnHold",
"Resolved",
"Closed",
"Canceled"
],
"description": "ServiceNow incident states in the v2 service-ticket contract."
},
"ServiceTicketServiceNowUrgency": {
"enum": [
"High",
"Medium",
"Low"
],
"description": "ServiceNow urgency levels in the v2 service-ticket contract."
}
}
}Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/contraforce-paginated-api-response-of-service-ticket-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.