{
"info": {
"_postman_id": "f2560b7b-1569-4de1-ab69-29e23730c53f",
"name": "Projects API",
"description": "PEXA Projects External Client API for Projects
This API uses the OAuth 2.0 protocol for authentication and authorization. It supports the following OAuth 2.0 flows:
- Client Credentials
- Authorization Code
Scopes are used to grant an application different levels of access to data. Each API endpoint will require specific scopes.
The scopes are listed against each API endpoint.
For more information, see the following guides:
- [Authentication](../../../Exchange/docs/documentation/)\n\n\nContact Support:\n Name: PEXA Projects\n Email: pexaprojects-prdsupport@pexa.com.au",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"createdAt": "2026-07-28T02:35:38.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"lastUpdatedBy": "35240",
"uid": "35240-f2560b7b-1569-4de1-ab69-29e23730c53f"
},
"item": [
{
"name": "v4",
"item": [
{
"name": "projects",
"item": [
{
"name": "{projectId}",
"item": [
{
"name": "statuses",
"item": [
{
"name": "statuses",
"id": "f6081d48-1b13-46bd-b879-0de8e3876934",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "au:projects:project:write au:projects:status:read au:projects:workspaces:read",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/auth",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"id": "be839c6e-75de-49cc-8238-3812606bc61e",
"key": "projectId",
"value": "",
"description": "(Required) Id of the project to find status details for"
}
]
},
"description": "Fetch the status details for a project
Scopes:
au:projects:status:read"
},
"response": [
{
"id": "f24e10c8-eab3-4d26-a05b-db772913ba54",
"name": "Status details for a project",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"key": "projectId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"jurisdiction\": \"SA\",\n \"proprietorOnTitles\": [\n \"\",\n \"\"\n ],\n \"parentTitle\": \"\",\n \"mortgageeNames\": [\n \"\",\n \"\"\n ],\n \"estimatedSettlementDate\": \"\",\n \"invitationAcceptance\": {\n \"incomingMortgagee\": {\n \"accepted\": \"\",\n \"pending\": \"\",\n \"declined\": \"\",\n \"notInvited\": \"\"\n },\n \"mortgageeOnTitle\": {\n \"accepted\": \"\",\n \"pending\": \"\",\n \"declined\": \"\",\n \"notInvited\": \"\"\n },\n \"incomingProprietor\": {\n \"accepted\": \"\",\n \"pending\": \"\",\n \"declined\": \"\",\n \"notInvited\": \"\"\n }\n },\n \"settlementDateAcceptance\": {\n \"incomingMortgagee\": {\n \"accepted\": \"\",\n \"pending\": \"\"\n },\n \"mortgageeOnTitle\": {\n \"accepted\": \"\",\n \"pending\": \"\"\n },\n \"incomingProprietor\": {\n \"accepted\": \"\",\n \"pending\": \"\"\n }\n },\n \"workspaceStatus\": {\n \"allActive\": \"\",\n \"settlingToday\": \"\",\n \"completed\": \"\",\n \"withdrawn\": \"\",\n \"all\": \"\",\n \"awaitingDigitalSignature\": \"\"\n }\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-f24e10c8-eab3-4d26-a05b-db772913ba54"
},
{
"id": "f38d083f-9a65-42f0-b4ec-6d02dc36db93",
"name": "Error Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"key": "projectId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-f38d083f-9a65-42f0-b4ec-6d02dc36db93"
},
{
"id": "dfa2debc-c3a3-4b84-b1c3-b777d84696f6",
"name": "Error Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"key": "projectId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-dfa2debc-c3a3-4b84-b1c3-b777d84696f6"
},
{
"id": "1656603b-0239-4635-a980-348973628273",
"name": "Error Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"key": "projectId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-1656603b-0239-4635-a980-348973628273"
},
{
"id": "8cb4271e-81b3-405e-b4ac-d5a45bbfe83b",
"name": "Error Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"statuses"
],
"variable": [
{
"key": "projectId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-8cb4271e-81b3-405e-b4ac-d5a45bbfe83b"
}
],
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-f6081d48-1b13-46bd-b879-0de8e3876934"
}
],
"id": "cc645303-c12f-4c5b-a79b-1774d351f6df",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-cc645303-c12f-4c5b-a79b-1774d351f6df"
},
{
"name": "workspaces",
"item": [
{
"name": "{pexaWorkspaceId}",
"item": [
{
"name": "settlementDates",
"item": [
{
"name": "Propose Settlement Date",
"id": "6a3de1b8-1f36-41b4-a27b-41729baa6db4",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "au:projects:project:write au:projects:status:read au:projects:workspaces:read",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/auth",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"id": "24c20365-b6df-4c2b-9f4e-9e2b5ec2c63a",
"key": "projectId",
"value": "",
"description": "(Required) Id of the project that the workspace resides in"
},
{
"id": "1255539f-8133-4465-9cec-7cb0574c50a2",
"key": "pexaWorkspaceId",
"value": "",
"description": "(Required) The workspace to propose settlement date for"
}
]
},
"description": "Propose a settlement date to an existing workspace
Scopes:
au:projects:workspaces:write"
},
"response": [
{
"id": "e8657e29-1ed8-4ae9-a9fc-115ed1344d81",
"name": "No Content",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-e8657e29-1ed8-4ae9-a9fc-115ed1344d81"
},
{
"id": "2e5edb76-30b0-48ad-aa3f-873950f2145c",
"name": "Error Response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-2e5edb76-30b0-48ad-aa3f-873950f2145c"
},
{
"id": "77fb69ac-c1c4-45c5-8284-196f402e70e3",
"name": "Error Response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-77fb69ac-c1c4-45c5-8284-196f402e70e3"
},
{
"id": "8141622c-5cf1-4193-8814-3524cedada44",
"name": "Error Response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-8141622c-5cf1-4193-8814-3524cedada44"
},
{
"id": "17faae15-c4e5-4779-9938-79242e3cdc0c",
"name": "Error Response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"settlementDateAndTime\": \"\",\n \"reason\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId/settlementDates",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId",
"settlementDates"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-17faae15-c4e5-4779-9938-79242e3cdc0c"
}
],
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-6a3de1b8-1f36-41b4-a27b-41729baa6db4"
}
],
"id": "cd361e2b-606c-4740-ad44-b3d747c370c8",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-cd361e2b-606c-4740-ad44-b3d747c370c8"
},
{
"name": "Update a workspace",
"id": "853380e5-d9cf-4bf3-b994-3b7ca9c98cfb",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "au:projects:project:write au:projects:status:read au:projects:workspaces:read",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/auth",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"id": "4ed52c2f-d16d-422d-a8a5-4b0ffa9c587b",
"key": "projectId",
"value": "",
"description": "(Required) Id of the project to update workspaces for"
},
{
"id": "2ab6efd7-1bc2-4e54-80a9-ae7e8ca56199",
"key": "pexaWorkspaceId",
"value": "",
"description": "(Required) The workspace update"
}
]
},
"description": "Updates a workspace of a given project with parameters 'projectId', 'pexaWorkspaceId' and 'payload'
Scopes:
au:projects:workspaces:write"
},
"response": [
{
"id": "f681746e-a40a-4b48-9b83-5de9499d7787",
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"workspaceId\": \"\",\n \"subscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-f681746e-a40a-4b48-9b83-5de9499d7787"
},
{
"id": "b6773e51-0076-4be1-b3a5-63ea9a5a5eae",
"name": "Error Response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-b6773e51-0076-4be1-b3a5-63ea9a5a5eae"
},
{
"id": "ebd3ee27-9c7d-4f4b-bda6-2c65ceb54122",
"name": "Error Response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-ebd3ee27-9c7d-4f4b-bda6-2c65ceb54122"
},
{
"id": "5c1c74a0-f5bf-472f-80e8-03963b59dd02",
"name": "Error Response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-5c1c74a0-f5bf-472f-80e8-03963b59dd02"
},
{
"id": "f2dd3646-74cc-4a72-9bb3-3e6bec84d4a1",
"name": "Error Response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newSubscriberReference\": \"\",\n \"childTitles\": [\n \"\",\n \"\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:pexaWorkspaceId",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":pexaWorkspaceId"
],
"variable": [
{
"key": "projectId"
},
{
"key": "pexaWorkspaceId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"exceptionList\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-f2dd3646-74cc-4a72-9bb3-3e6bec84d4a1"
}
],
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-853380e5-d9cf-4bf3-b994-3b7ca9c98cfb"
}
],
"id": "2c3195ea-250c-4140-9552-f242ec58c05e",
"createdAt": "2026-07-28T02:35:39.000Z",
"updatedAt": "2026-07-28T02:35:39.000Z",
"uid": "35240-2c3195ea-250c-4140-9552-f242ec58c05e"
},
{
"name": "{workspaceId}",
"item": [
{
"name": "financials",
"item": [
{
"name": "Create Financial Settlement Line Items",
"id": "4ec4ac33-87c4-422d-9018-f477b3d7bd8d",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "au:projects:project:write au:projects:status:read au:projects:workspaces:read",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://host.kubernetes.internal/auth/realms/pexa/protocol/openid-connect/auth",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"role\": \"\",\n \"schedule\": {\n \"lineItems\": [\n {\n \"accountDetails\": {\n \"destination\": {\n \"account\": {\n \"accountBsb\": \"\",\n \"accountName\": \"\",\n \"accountNumber\": \"\"\n },\n \"bpay\": {\n \"billerCode\": \"\",\n \"reference\": \"\"\n },\n \"officeAccount\": \"\",\n \"preverifiedAccount\": \"\"\n },\n \"source\": {\n \"defaultAccount\": \"\",\n \"preverifiedAccount\": \"\"\n }\n },\n \"associatedSubscriber\": \"\",\n \"category\": \"\",\n \"customCategory\": \"\",\n \"clientName\": \"\",\n \"transactionDescription\": \"\",\n \"verified\": \"\",\n \"verifiedBy\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"accountDetails\": {\n \"destination\": {\n \"account\": {\n \"accountBsb\": \"\",\n \"accountName\": \"\",\n \"accountNumber\": \"\"\n },\n \"bpay\": {\n \"billerCode\": \"\",\n \"reference\": \"\"\n },\n \"officeAccount\": \"\",\n \"preverifiedAccount\": \"\"\n },\n \"source\": {\n \"defaultAccount\": \"\",\n \"preverifiedAccount\": \"\"\n }\n },\n \"associatedSubscriber\": \"\",\n \"category\": \"\",\n \"customCategory\": \"\",\n \"clientName\": \"\",\n \"transactionDescription\": \"\",\n \"verified\": \"\",\n \"verifiedBy\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/v4/projects/:projectId/workspaces/:workspaceId/financials",
"host": [
"{{baseUrl}}"
],
"path": [
"v4",
"projects",
":projectId",
"workspaces",
":workspaceId",
"financials"
],
"variable": [
{
"id": "6ae874b3-05e4-4649-9648-60537bcf01fe",
"key": "projectId",
"value": "",
"description": "(Required) Id of the project to upload financials for"
},
{
"id": "35f68519-c23f-4e28-a608-80abcd96f9c8",
"key": "workspaceId",
"value": "",
"description": "(Required) The workspace to upload financials for"
}
]
},
"description": "Add financial settlement line items to an existing workspace
Scopes:
au:projects:workspaces:write"
},
"response": [
{
"id": "264ed95b-2f7e-4d24-baa3-739cf5610457",
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A unique request id provided by api caller to support end-to-end troubleshooting and tracing",
"key": "X-Request-Correlation-Id",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"role\": \"\",\n \"schedule\": {\n \"lineItems\": [\n {\n \"accountDetails\": {\n \"destination\": {\n \"account\": {\n \"accountBsb\": \"\",\n \"accountName\": \"\",\n \"accountNumber\": \"\"\n },\n \"bpay\": {\n \"billerCode\": \"\",\n \"reference\": \"\"\n },\n \"officeAccount\": \"\",\n \"preverifiedAccount\": \"\"\n },\n \"source\": {\n \"defaultAccount\": \"\",\n \"preverifiedAccount\": \"\"\n }\n },\n \"associatedSubscriber\": \"\",\n \"category\": \"\",\n \"customCategory\": \"\",\n \"clientName\": \"