GET

Get portal by ID

Get a portal with the specified ID.

Request

Path parameters

portalId

string

Required

Responses

Returns the requested portal.

application/json

PortalDTO
GET/servicedeskapi/portals/{portalId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/portals/{portalId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 { "description": "<string>", "id": 2154, "name": "<string>", "get_links": { "self": "<string>" } }
GET

Get portal by key

Get a portal for the project by key.

Request

Path parameters

projectKey

string

Required

Responses

Returns the requested portal.

application/json

PortalDTO
GET/servicedeskapi/portals/project/{projectKey}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/portals/project/{projectKey}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 { "description": "<string>", "id": 2154, "name": "<string>", "get_links": { "self": "<string>" } }
GET

Get portals

Get all portals. Returns a maximum of 50 portals per page.

Request

Query parameters

start

number

limit

number

Responses

Returns a page of portals.

application/json

object
GET/servicedeskapi/portals
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/portals' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "_expands": [ "<string>" ], "size": 1, "start": 0, "limit": 50, "isLastPage": true, "_links": { "base": "<string>", "context": "<string>", "next": "<string>", "prev": "<string>", "self": "<string>" }, "values": [ { "description": "<string>", "id": 2154, "name": "<string>", "get_links": { "self": "<string>" } } ] }

Rate this page: