API reference

Help center (customer portal)

Raise, follow, reply to and rate service requests as a customer.

`GET /v1/portal/issues/:org`

Help centers in an organization the caller can use.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.

Response 200

{
  org: {
    name: string
    slug: string
  }
  spaces: {
    key: string
    name: string
    title: string
    intro: string
  }[]
}

Errors

Status	Message
`403`	Help centers are for people.

`GET /v1/portal/issues/:org/:spaceKey`

A help center: title, intro and request types.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).

Response 200

{
  org: {
    name: string
    slug: string
  }
  space: {
    key: string
    name: string
    icon?: string
    color?: string
  }
  portal: {
    title: string
    intro: string
  }
  satisfaction: boolean
  requestTypes: {
    id: string
    name: string
    description: string
    icon?: string
    group: string
    fields: {
      id: "priority"
      name: string
      options: {
        id: string
        name: string
      }[]
    }[]
  }[]
}

Errors

Status	Message
`403`	Help centers are for people.

`GET /v1/portal/issues/:org/:spaceKey/requests`

The caller's requests (reported or participating): status open, closed or all.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).

Query parameter	Type	Required	Notes
`status`	`"open" \| "closed" \| "all"`	No

Response 200

{
  requests: {
    key: string
    summary: string
    requestType: null | string
    status: string
    statusCategory: "done" | "todo" | "inprogress"
    waitingForYou: boolean
    resolution: null | string
    satisfaction: null | number
    createdAt: number
    updatedAt: number
  }[]
}

Errors

Status	Message
`403`	Help centers are for people.

`POST /v1/portal/issues/:org/:spaceKey/requests`

Raises a request.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).

Request body

Field	Type	Required	Notes
`requestType`	`string`	Yes	up to 40 characters
`summary`	`string`	Yes	1–255 characters; trimmed
`description`	`string`	No	up to 32,000 characters
`priority`	`string`	No	up to 40 characters

Response 201

{
  key: string
}

Errors

Status	Message
`403`	Help centers are for people.

`GET /v1/portal/issues/:org/:spaceKey/requests/:issueKey`

One of the caller's requests with its public conversation.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).
`:issueKey`	Issue key (`WEB-12`; former keys of moved issues and renamed spaces work too) or issue id (`iss_…`).

Response 200

{
  request: {
    description: string
    reporter: string
    key: string
    summary: string
    requestType: null | string
    status: string
    statusCategory: "done" | "todo" | "inprogress"
    waitingForYou: boolean
    resolution: null | string
    satisfaction: null | number
    createdAt: number
    updatedAt: number
  }
  comments: {
    id: string
    body: string
    author: string
    mine: boolean
    at: number
  }[]
}

Errors

Status	Message
`403`	Help centers are for people.

`POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/comments`

Replies on a request.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).
`:issueKey`	Issue key (`WEB-12`; former keys of moved issues and renamed spaces work too) or issue id (`iss_…`).

Request body

Field	Type	Required	Notes
`body`	`string`	Yes	1–32,000 characters; trimmed

Response 201

{
  ok: boolean
}

Errors

Status	Message
`403`	Help centers are for people.

`POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/rating`

Rates a resolved request, 1–5, once.

Auth: user access token or platform agent key

Path parameter	Description
`:org`	Organization slug, as in the help center link.
`:spaceKey`	Space key (`WEB`; former keys work too) or space id (`spc_…`).
`:issueKey`	Issue key (`WEB-12`; former keys of moved issues and renamed spaces work too) or issue id (`iss_…`).

Request body

Field	Type	Required	Notes
`rating`	`integer`	Yes	1–5
`comment`	`string`	No	up to 1,000 characters

Response 200

{
  ok: boolean
}

Errors

Status	Message
`403`	Help centers are for people.