Get a change proposal
With the proposed document and its diff from the base version (JSON Patch).
GET
With the proposed document and its diff from the base version (JSON Patch).
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidOK
application/json- response
id*stringFormat
uuidkind*stringdefinitionId*|Format
uuidname*stringsummary*stringstatus*stringValue in
"open""approved""rejected"stale*booleanauthor*createdAt*stringFormat
date-timereviewedBy*|nullreviewedAt*|Format
date-timebaseVersionId*|Format
uuidschemaVersion*integerdefinition?unknownpatch*array<>resultVersionId*|Format
uuidreviewNote*string|nullcurl -X GET 'https://api.postforge.dev/v1/change-proposals/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a", "name": "string", "summary": "string", "status": "open", "stale": true, "author": { "type": "user", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "createdAt": "2019-08-24T14:15:22Z", "reviewedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "reviewedAt": "2019-08-24T14:15:22Z", "baseVersionId": "238d56e0-9ec7-4ebf-bfb2-e487b4bc769c", "schemaVersion": 0, "definition": null, "patch": [ { "op": "add", "path": "string", "value": null } ], "resultVersionId": "5bdef736-5d13-4b91-8666-e0cb14973657", "reviewNote": "string"}