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

Klaus PubImportApi API

The PubImportApi API from Klaus — 3 operation(s) for pubimportapi.

Klaus PubImportApi API is one of 2 APIs that Klaus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://yoursubdomain.zendesk.com/qa.

4 operations 3 paths 11 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://yoursubdomain.zendesk.com/qa
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Klaus PubImportApi API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Enter the token with the "Bearer " prefix

Paths & Operations 4

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

PubImportApi 4
DELETE
/api/import/tickets
PubImportApi_DeleteImportedTicket 1 param → 200default
POST
/api/import/tickets
PubImportApi_ImportTickets 1 param → 200default
GET
/api/import/tickets/{ticketExternalId}
PubImportApi_GetImportedTicket 1 param → 200default
POST
/api/import/users
PubImportApi_ImportUsers 1 param → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are protoPubTicketImport (19 properties), protoPubImportedTicket (16 properties), protoPubCommentImport (14 properties), protoPubImportedComment (13 properties). Each schema is shown below with its type and property counts.

protoPubUserImportRequest
object
1 property
protoPubCommentImport
object
14 properties
protoPubUserImport
object
2 properties
protoPubImportedTicket
object
16 properties
protobufAny
object
1 property
protoPubTicketImport
object
19 properties
protoPubImportedComment
object
13 properties
protoPubTicketImportRequest
object
1 property
rpcStatus
object
3 properties
protoPubTicketFieldValue
object
2 properties
protoPubTicketField
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

klaus-pubimportapi-api-openapi.yml Raw ↑

Other APIs Klaus publishes across the network.

Klaus PublicExportApi API