{ "item": [ { "name": "inbound", "description": "", "item": [ { "name": "leads", "description": "", "item": [ { "id": "b6178e04-e8b8-442b-86a4-49347b570652", "name": "Create or merge a lead", "request": { "name": "Create or merge a lead", "description": { "content": "Scope `leads:write`. De-duplicated by normalised address within the company.", "type": "text/plain" }, "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6c7cff76-955f-44fa-b9ed-5c2b5a42e3e7", "name": "Merged into an existing lead or project", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"leadId\": \"\",\n \"projectId\": \"\",\n \"reason\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd6584d-1ce7-4ac8-8ea3-9710890971e8", "name": "Created", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"leadId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fafe8aeb-caa4-4f4d-a638-878c1480fef9", "name": "Validation failed; the message names the field", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c209be25-89b8-4d40-b154-160de7b69a92", "name": "Missing", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ded566-e9f8-409d-95a4-f579d94d8d51", "name": "Key lacks the scope", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c84b31bc-9e47-4a15-a4b4-4f1efa8e2c34", "name": "Rate limited; honour retry-after", "originalRequest": { "url": { "path": [ "inbound", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"smsConsent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "appointments", "description": "", "item": [ { "id": "5b918707-9119-4cad-9127-dbfc15b8cfa0", "name": "Book an appointment", "request": { "name": "Book an appointment", "description": { "content": "Scope `appointments:write`. Idempotent on `idempotencyKey`; a replay with a different body returns 409.", "type": "text/plain" }, "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fb2ed0de-3efc-49bb-8181-a2679e4bf6e8", "name": "Replay of an identical request", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd5c7c73-0f6f-4067-8a90-cdc946f3e4ef", "name": "Created", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"appointmentId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf7a8893-38dd-4683-8b0b-5a40c4e3f108", "name": "Validation failed; the message names the field", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4aaf38-42ce-4f4f-a1a3-7b694277768f", "name": "Missing", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef2cb413-a176-43a9-a542-46cfe7355b36", "name": "Key lacks the scope", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39381096-fea5-4eef-8990-e1c40caaf1e7", "name": "Idempotency-Key reused with a different request", "originalRequest": { "url": { "path": [ "inbound", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"idempotencyKey\": \"\",\n \"projectId\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "jobs", "description": "", "item": [ { "id": "566f2638-f022-4c6f-8f4b-1cc323f5b551", "name": "List sold jobs for the key's contractor", "request": { "name": "List sold jobs for the key's contractor", "description": { "content": "Scope `jobs:read`, installer-contractor key.", "type": "text/plain" }, "url": { "path": [ "inbound", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a919fd87-4b8b-4cf0-9701-253b1b0289bd", "name": "Jobs, most recently updated first", "originalRequest": { "url": { "path": [ "inbound", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobs\": [\n {\n \"id\": \"\",\n \"workOrderNo\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"stage\": \"\",\n \"installerNote\": \"\",\n \"lastUpdated\": \"\"\n },\n {\n \"id\": \"\",\n \"workOrderNo\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"stage\": \"\",\n \"installerNote\": \"\",\n \"lastUpdated\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "fc15b398-6524-4e0b-aee5-18fb8351d023", "name": "Append an installer note to a job", "request": { "name": "Append an installer note to a job", "description": { "content": "Scope `jobs:status:write`, installer-contractor key.", "type": "text/plain" }, "url": { "path": [ "inbound", "jobs", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a783cc09-523e-4142-8bb4-2179ffbe1998", "name": "Recorded", "originalRequest": { "url": { "path": [ "inbound", "jobs", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44eb6cc9-fd95-4522-b196-299da1a0f191", "name": "Job not visible to this key", "originalRequest": { "url": { "path": [ "inbound", "jobs", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "partner", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "jobs", "description": "", "item": [ { "id": "cd1b9b49-b874-4487-ab12-7641d6591b8c", "name": "Change feed of jobs assigned to your company", "request": { "name": "Change feed of jobs assigned to your company", "description": { "content": "Scope `jobs:read`. Persist `nextCursor`; without a cursor the latest page is returned.", "type": "text/plain" }, "url": { "path": [ "partner", "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "581d9834-827a-4102-9e02-9ef7d000bb3a", "name": "Page of changes", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-ridge-arc-api-version", "value": "" } ], "body": "{\n \"apiVersion\": \"\",\n \"resources\": [\n {\n \"sequence\": \"\",\n \"changedAt\": \"\",\n \"resource\": {\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer\": {\n \"name\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n },\n \"scope\": {\n \"packageName\": \"\",\n \"systemType\": \"\",\n \"scopeVersion\": \"\"\n },\n \"schedule\": {\n \"status\": \"UNSCHEDULED\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\"\n },\n \"readiness\": {\n \"ready\": \"\",\n \"blockerCodes\": [\n \"\",\n \"\"\n ]\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"category\": \"MANUAL\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n },\n {\n \"id\": \"\",\n \"category\": \"SCOPE\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n }\n ],\n \"technicianAssignments\": [\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n },\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n },\n {\n \"sequence\": \"\",\n \"changedAt\": \"\",\n \"resource\": {\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"COMPLETE\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer\": {\n \"name\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n },\n \"scope\": {\n \"packageName\": \"\",\n \"systemType\": \"\",\n \"scopeVersion\": \"\"\n },\n \"schedule\": {\n \"status\": \"CONFIRMED\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\"\n },\n \"readiness\": {\n \"ready\": \"\",\n \"blockerCodes\": [\n \"\",\n \"\"\n ]\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"category\": \"MANUAL\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n },\n {\n \"id\": \"\",\n \"category\": \"CONTRACT_METADATA\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n }\n ],\n \"technicianAssignments\": [\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n },\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n }\n ],\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "dc81ed01-3fdf-4116-a831-dd1e5c4beeb0", "name": "One job", "request": { "name": "One job", "description": {}, "url": { "path": [ "partner", "v1", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3c4a268e-0669-46a8-8341-a8e566e73555", "name": "The installer-safe job", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apiVersion\": \"\",\n \"resource\": {\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"COMPLETE\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer\": {\n \"name\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n },\n \"scope\": {\n \"packageName\": \"\",\n \"systemType\": \"\",\n \"scopeVersion\": \"\"\n },\n \"schedule\": {\n \"status\": \"TENTATIVE\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\"\n },\n \"readiness\": {\n \"ready\": \"\",\n \"blockerCodes\": [\n \"\",\n \"\"\n ]\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"category\": \"MANUAL\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n },\n {\n \"id\": \"\",\n \"category\": \"SCOPE\",\n \"mime\": \"\",\n \"availableAt\": \"\"\n }\n ],\n \"technicianAssignments\": [\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n },\n {\n \"membershipId\": \"\",\n \"assignedAt\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75a733dc-4776-4f35-bc5a-34280096096e", "name": "Not assigned to your company", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "status-events", "description": "", "item": [ { "id": "9e935a94-5182-48b8-982a-244426fa4493", "name": "Post a status event", "request": { "name": "Post a status event", "description": { "content": "Scope `jobs:status:write`. Requires `Idempotency-Key`. Transitions are validated; 409 on stale `expectedVersion` or idempotency mismatch.", "type": "text/plain" }, "url": { "path": [ "partner", "v1", "jobs", ":id", "status-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"COMPLETE\",\n \"occurredAt\": \"\",\n \"expectedVersion\": \"\",\n \"note\": \"\",\n \"blockerCode\": \"CUSTOMER_UNAVAILABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e6e9e67f-8a6d-406c-988d-e737c562afd1", "name": "Recorded; returns the job at its new version", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "status-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"COMPLETE\",\n \"occurredAt\": \"\",\n \"expectedVersion\": \"\",\n \"note\": \"\",\n \"blockerCode\": \"CUSTOMER_UNAVAILABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85ca6eff-7265-4f88-ba46-9e4596650262", "name": "Idempotency-Key reused with a different request", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "status-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"COMPLETE\",\n \"occurredAt\": \"\",\n \"expectedVersion\": \"\",\n \"note\": \"\",\n \"blockerCode\": \"CUSTOMER_UNAVAILABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ba7b497-1857-44f0-9853-bf3e8d672398", "name": "Transition not allowed from the current status", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "status-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"COMPLETE\",\n \"occurredAt\": \"\",\n \"expectedVersion\": \"\",\n \"note\": \"\",\n \"blockerCode\": \"CUSTOMER_UNAVAILABLE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "schedule", "description": "", "item": [ { "id": "8913e722-6fdf-4467-8343-44f680a470f9", "name": "Set or cancel the schedule", "request": { "name": "Set or cancel the schedule", "description": { "content": "Scope `jobs:schedule:write`. Requires `Idempotency-Key`.", "type": "text/plain" }, "url": { "path": [ "partner", "v1", "jobs", ":id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"TENTATIVE\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\",\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5aee926f-78da-4c2c-b678-42be6157b785", "name": "Updated job", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"TENTATIVE\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\",\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b49ec5f-8ec1-4714-a360-fbdf44a40294", "name": "Idempotency-Key reused with a different request", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"TENTATIVE\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"timeZone\": \"\",\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "assignments", "description": "", "item": [ { "id": "a35c1a48-a5ab-4511-9260-f4bf75813e99", "name": "Replace technician assignments", "request": { "name": "Replace technician assignments", "description": { "content": "Scope `jobs:assignment:write`. Requires `Idempotency-Key`.", "type": "text/plain" }, "url": { "path": [ "partner", "v1", "jobs", ":id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"membershipIds\": [\n \"\",\n \"\"\n ],\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8f69e630-2fb0-4e23-8453-8e910c1302cd", "name": "Updated job", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"membershipIds\": [\n \"\",\n \"\"\n ],\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "094d0325-e14c-4362-bdba-23f884e299e6", "name": "Idempotency-Key reused with a different request", "originalRequest": { "url": { "path": [ "partner", "v1", "jobs", ":id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Idempotency-Key", "value": "x9Dn8Gw3:" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"membershipIds\": [\n \"\",\n \"\"\n ],\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "technicians", "description": "", "item": [ { "id": "e711d740-ad18-4319-b169-9d37e55820ce", "name": "Your technicians", "request": { "name": "Your technicians", "description": { "content": "Scope `technicians:read`.", "type": "text/plain" }, "url": { "path": [ "partner", "v1", "technicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0fc60337-95a1-479d-9a32-83f4291a722c", "name": "Memberships", "originalRequest": { "url": { "path": [ "partner", "v1", "technicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"technicians\": [\n {\n \"membershipId\": \"\",\n \"displayName\": \"\",\n \"active\": \"\"\n },\n {\n \"membershipId\": \"\",\n \"displayName\": \"\",\n \"active\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://vesta-staging.hbjeffery.workers.dev/api" } ], "info": { "_postman_id": "78502743-0c8c-4afb-a4a0-09efd58414ad", "name": "Ridge Arc Network partner APIs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Partner-facing surfaces of Ridge Arc Network: the Inbound API (leads, appointments,\ncontractor job pull) and the Installer API v1. Webhook envelope and headers are\ndocumented as components. Authentication is an API key in the `x-api-key` header,\npresented as `.`. Scopes are fixed by key kind.\n\n\nContact Support:\n Email: developers@ridgearcnetwork.com", "type": "text/plain" } } }