Skip to navigation

Get ticket service portal

View as Markdown

Returns one ticket service portal by its id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the ticket service portal, as returned when it was created or listed.

Response

The ticket service portal
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
connector_idstringOptionalformat: "uuid">=1 character

The ticketing system connector this service portal belongs to. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

portal_urlstringOptionalformat: "(?:https?:\/\/)?.*">=1 character

The full URL of the customer-facing service portal homepage.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error