fp2 documentation

curl -X POST https://new.fp.dev/api/v1/projects/projectId/issues/reference/claim \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "client_id": "string"
}'

{
  "id": "string",
  "display_id": "string",
  "project_id": "string",
  "title": "string",
  "body": "string",
  "status": "todo",
  "priority": "urgent",
  "parent_id": "string",
  "holder": {
    "kind": "user",
    "id": "string",
    "name": "string",
    "held_at": "string",
    "held_until": "string",
    "handle": "string"
  },
  "created_by": {
    "kind": "user",
    "id": "string",
    "name": "string",
    "handle": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "comments": [
    {
      "id": "string",
      "issue_id": "string",
      "author": {
        "kind": "user",
        "id": "string",
        "name": "string",
        "handle": "string"
      },
      "body": "string",
      "kind": "progress",
      "resolves": "string",
      "resolved": true,
      "created_at": "string"
    }
  ],
  "parent": {
    "id": "string",
    "display_id": "string",
    "title": "string",
    "status": "todo"
  },
  "children": [
    {
      "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"
    }
  ],
  "children_total": "NaN",
  "children_open": "NaN",
  "children_in_progress": "NaN",
  "children_held": "NaN",
  "children_stalled": "NaN",
  "pull_requests": [
    {
      "id": "string",
      "host": "string",
      "owner": "string",
      "repo": "string",
      "number": "NaN",
      "title": "string",
      "url": "string",
      "linked_by": {
        "kind": "user",
        "id": "string",
        "name": "string",
        "handle": "string"
      },
      "linked_at": "string"
    }
  ],
  "pull_requests_total": "NaN",
  "open_questions": "NaN",
  "actions": [
    {
      "name": "string",
      "title": "string",
      "method": "POST",
      "href": "string",
      "effect": "safe",
      "reversible": true,
      "fields": [
        {
          "kind": "constant",
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "blocked": [
    {
      "name": "string",
      "reason_code": "illegal_edge",
      "message": "string"
    }
  ]
}

Takes an issue, so that only its holder may transition it or link a pull request to it, and the advertised action set withholds child creation from everyone else as well. The claim is a lease: holder.held_until rides on the representation, the writes its holder authors on the issue push it further out — today a comment, a transition, or re-claiming it — and there is no heartbeat endpoint. A live claim held by somebody else is refused with issue_held, which names the holder. client_id is required but no ledger consults it: re-sending a lost claim succeeds and refreshes the lease rather than replaying an earlier result, and a duplicate arriving after the holder released re-acquires the issue.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

referencestringRequired

Request

This endpoint expects an object.

client_idanyRequired

Response

Success

idany

display_idstring

project_idstring

titlestringformat: ".*\S.*"<=200 characters

bodyany

statusenum

Allowed values:

priorityenum or null

Allowed values:

parent_idstring or null

holderobject or null

created_byobject

created_atstring

updated_atstring

commentslist of objects

parentobject or null

childrenlist of objects

children_totaldouble or enum or enum

children_opendouble or enum or enum

children_in_progressdouble or enum or enum

children_helddouble or enum or enum

children_stalleddouble or enum or enum

pull_requestslist of objects

pull_requests_totaldouble or enum or enum

open_questionsdouble or enum or enum

actionslist of objects

blockedlist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error