fp2 documentation

{
  "query": "string",
  "scope": {
    "fields": [
      "title"
    ],
    "searched_total": "NaN"
  },
  "matched_total": "NaN",
  "results": [
    {
      "id": "string",
      "display_id": "string",
      "project_id": "string",
      "title": "string",
      "status": "todo",
      "priority": "urgent",
      "parent_id": "string",
      "holder": {
        "kind": "user",
        "id": "string",
        "name": "string",
        "held_at": "string",
        "held_until": "string",
        "handle": "string"
      },
      "updated_at": "string",
      "match": {
        "field": "title",
        "snippet": "string",
        "ranges": [
          [
            "string"
          ]
        ]
      }
    }
  ],
  "facets": {
    "todo": "NaN",
    "in_progress": "NaN",
    "review": "NaN",
    "done": "NaN",
    "cancelled": "NaN"
  }
}

Matches the query against issue titles and bodies; comments are not searched, and scope.fields says so. results is a bounded slice, matched_total and scope.searched_total are the truth about it, and facets counts matches per status across the whole match set rather than the returned page.

Authentication

AuthorizationBearer

Pass an attributable fp2 API key as Authorization: Bearer <key>. Never embed keys in repositories or documentation.

Path parameters

projectIdstringRequired

Query parameters

qstringRequired1-200 characters

statusenum or nullOptional

Allowed values:

limitstring or nullOptional

Response

Success

querystring

scopeobject

matched_totaldouble or enum or enum

resultslist of objects

facetsobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error