📘
Getting started
To get started, see lookups in the app components guide.

Schemas

AttachedResource

The response to a successful lookup request.

Property	Type	Description
`error`	string	The error that should be displayed to the user.
`resource_name` (required)	string	The name of the attached resource.
`resource_url` (required)	string	The URL of the attached resource.

{
  "error": "No resource matched that input",
  "resource_name": "Build the Thing",
  "resource_url": "https://example.atlassian.net/browse/CP-1"
}

TypeaheadList

The response to a successful typeahead request.

Property	Type	Description
`header`	string	Optional. Header text to display above the list of typeahead results. If no `header` is passed in or the value is an empty string, only the typeahead results with be rendered.
`items` (required)	[object]	Array of TypeaheadItem objects that indicate typeahead results.
» `icon_url`	string	The URL of the icon to display next to the title.
» `subtitle`	string	The subtitle of the typeahead item.
» `title` (required)	string	The title of the typeahead item.
» `value` (required)	string	The value of the typeahead item.

{
  "header": "List of messages",
  "items": [
    {
      "icon_url": "https://example-icon.png",
      "subtitle": "OTP",
      "title": "OTP Team PF",
      "value": "OTP"
    }
  ]
}

TypeaheadItem

An object describing a typeahead result.

Property	Type	Description
`icon_url`	string	The URL of the icon to display next to the title.
`subtitle`	string	The subtitle of the typeahead item.
`title` (required)	string	The title of the typeahead item.
`value` (required)	string	The value of the typeahead item.

{
  "icon_url": "https://example-icon.png",
  "subtitle": "OTP",
  "title": "OTP Team PF",
  "value": "OTP"
}

Error schemas

BadRequest

Property	Type	Description
`data`	object	An object containing an `error` string to display to the user.
» `error`	string	The error to display.

An error response object indicating a bad request (i.e., a status code of 400).

{
  "data": {
    "error": "Illegal or malformed request."
  }
}

Forbidden

An error response object indicating a forbidden request (i.e., a status code of 403).

Property	Type	Description
`data`	object	An object containing an `error` string to display to the user.
» `error`	string	The error to display.

{
  "data": {
    "error": "Access forbidden."
  }
}

InternalServerError

An error response object indicating a request that could not be found (i.e., a status code of 500).

Property	Type	Description
`data`	object	An object containing an `error` string to display to the user.
» `error`	string	The error to display.

{
  "data": {
    "error": "Internal server error."
  }
}

NotFound

An error response object indicating a request that could not be found (i.e., a status code of 404).

Property	Type	Description
`data`	object	An object containing an `error` string to display to the user.
» `error`	string	The error to display.

{
  "data": {
    "error": "Not found."
  }
}

Unauthorized

An error response object indicating a unauthorized request (i.e., a status code of 401).

Property	Type	Description
`data`	object	An object containing an `error` string to display to the user.
» `error`	string	The error to display.

{
  "data": {
    "error": "Authorization required."
  }
}