fp2 documentation

{
  "id": "string",
  "display_id": "string",
  "project_id": "string",
  "title": "string",
  "body": "string",
  "status": "todo",
  "priority": "urgent",
  "parent_id": "string",
  "created_by": {
    "kind": "user",
    "id": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "comments": [
    {
      "id": "string",
      "issue_id": "string",
      "author": {
        "kind": "user",
        "id": "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",
      "updated_at": "string"
    }
  ],
  "children_total": "NaN",
  "children_open": "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"
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

referencestringRequired

Response

Success

idany

display_idstring

project_idstring

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

bodyany

statusenum

priorityenum or null

parent_idstring 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

open_questionsdouble or enum or enum

actionslist of objects

blockedlist of objects

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

1	{
2	"id": "string",
3	"display_id": "string",
4	"project_id": "string",
5	"title": "string",
6	"body": "string",
7	"status": "todo",
8	"priority": "urgent",
9	"parent_id": "string",
10	"created_by": {
11	"kind": "user",
12	"id": "string"
13	},
14	"created_at": "string",
15	"updated_at": "string",
16	"comments": [
17	{
18	"id": "string",
19	"issue_id": "string",
20	"author": {
21	"kind": "user",
22	"id": "string"
23	},
24	"body": "string",
25	"kind": "progress",
26	"resolves": "string",
27	"resolved": true,
28	"created_at": "string"
29	}
30	],
31	"parent": {
32	"id": "string",
33	"display_id": "string",
34	"title": "string",
35	"status": "todo"
36	},
37	"children": [
38	{
39	"id": "string",
40	"display_id": "string",
41	"project_id": "string",
42	"title": "string",
43	"status": "todo",
44	"priority": "urgent",
45	"parent_id": "string",
46	"updated_at": "string"
47	}
48	],
49	"children_total": "NaN",
50	"children_open": "NaN",
51	"open_questions": "NaN",
52	"actions": [
53	{
54	"name": "string",
55	"title": "string",
56	"method": "POST",
57	"href": "string",
58	"effect": "safe",
59	"reversible": true,
60	"fields": [
61	{
62	"kind": "constant",
63	"name": "string",
64	"value": "string"
65	}
66	]
67	}
68	],
69	"blocked": [
70	{
71	"name": "string",
72	"reason_code": "illegal_edge",
73	"message": "string"
74	}
75	]
76	}

$	curl https://new.fp.dev/api/v1/projects/projectId/issues/reference \
>	-H "Authorization: Bearer <token>"