{ "info": { "_postman_id": "65ec4ba6-a085-4fdc-a83b-1af86fe7c316", "name": "Arthur Applicants API", "description": "Arthur Applicants API - the applicants surface of the Arthur API v2, the UK property management platform from Arthur Online (an Aareon company). Derived operation-for-operation from the provider's public Postman Documenter collection at https://developer.arthuronline.co.uk/. Every request is scoped to an Arthur entity via the mandatory X-EntityID header and authorised with an OAuth 2.0 Authorization Code access token.\n\nContact Support:\n Name: Arthur Online API Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:05:04.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "lastUpdatedBy": "35240", "uid": "35240-65ec4ba6-a085-4fdc-a83b-1af86fe7c316" }, "item": [ { "name": "applicants", "item": [ { "name": "{applicant_id}", "item": [ { "name": "assets", "item": [ { "name": "List Assets On Applicant", "id": "373f9f5a-759f-4d5c-9f81-d3e5651eb31c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "c8726a86-00d4-4e96-a67d-c4e15773faaf", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of assets associated with the given applicant ID." }, "response": [ { "id": "86422d46-27b1-45d7-a002-4c236c194d4e", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-86422d46-27b1-45d7-a002-4c236c194d4e" }, { "id": "56950ae9-16af-4961-9ea3-07f90b433436", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-56950ae9-16af-4961-9ea3-07f90b433436" }, { "id": "5f52ead9-66f5-4c11-a4bd-a979ff90ce6f", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5f52ead9-66f5-4c11-a4bd-a979ff90ce6f" }, { "id": "10d235e0-a684-4197-b42d-02def4403db5", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-10d235e0-a684-4197-b42d-02def4403db5" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-373f9f5a-759f-4d5c-9f81-d3e5651eb31c" }, { "name": "Create Asset On Applicant", "id": "e3691ca0-b061-4922-90c9-d3f9ff672d07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "884c8159-0ddb-428f-8dca-21328962c657", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to create a new asset related to an applicant . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String (base64) \n Yes \n\nmime_type \n application/pdf \n String \n Yes \n\nfile_name \n inventory \n String \n Yes" }, "response": [ { "id": "65c23957-69e0-4553-9865-8e2664f98342", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-65c23957-69e0-4553-9865-8e2664f98342" }, { "id": "fd4ad066-688a-4163-b522-11b59ce799e0", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-fd4ad066-688a-4163-b522-11b59ce799e0" }, { "id": "b7ed52e7-183c-442d-ba37-d371fa590b91", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b7ed52e7-183c-442d-ba37-d371fa590b91" }, { "id": "84448d46-6c68-48ef-a419-81be5a92b2d2", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-84448d46-6c68-48ef-a419-81be5a92b2d2" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-e3691ca0-b061-4922-90c9-d3f9ff672d07" } ], "id": "816820db-1024-47cf-89cb-67658dda1a8e", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-816820db-1024-47cf-89cb-67658dda1a8e" }, { "name": "managers", "item": [ { "name": "{manager_id}", "item": [ { "name": "List Managers on Applicant", "id": "d53ac169-da71-4128-a4d0-0e4cbdefb7f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "719de1df-3714-4e78-90c9-424a0bf0a66c", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." }, { "id": "7a12d5ec-a968-495f-8a36-9420346c4e4c", "key": "manager_id", "value": "", "description": "(Required) Arthur manager id." } ] }, "description": "This endpoint retrieves a list of assigned managers associated with the given applicant ID." }, "response": [ { "id": "b1b64f29-da11-48cd-a26a-52a8843f5f0a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b1b64f29-da11-48cd-a26a-52a8843f5f0a" }, { "id": "faa73e18-1a4d-4398-aa39-0450c90062ce", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-faa73e18-1a4d-4398-aa39-0450c90062ce" }, { "id": "cadf2b44-3656-46f5-b0a2-c06efa1e2790", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-cadf2b44-3656-46f5-b0a2-c06efa1e2790" }, { "id": "5cff6414-0f0f-45dd-b551-f36ddaebbaf1", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5cff6414-0f0f-45dd-b551-f36ddaebbaf1" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-d53ac169-da71-4128-a4d0-0e4cbdefb7f4" }, { "name": "Delete Manager on Applicant", "id": "89f86a36-34b9-4117-9a05-a2c620c60ac9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "variable": [ { "id": "38b63f44-6d7d-44a5-bc04-d85188e58719", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." }, { "id": "176adacd-b860-4884-9c44-aa268516a94c", "key": "manager_id", "value": "", "description": "(Required) Arthur manager id." } ] }, "description": "This endpoint deletes an existing assignee using the assigned manager\u00a0 id ." }, "response": [ { "id": "059865b8-0cbc-4c90-80f9-29e08facf2fb", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-059865b8-0cbc-4c90-80f9-29e08facf2fb" }, { "id": "5df22ff6-c51b-4253-994b-911676f6ec47", "name": "The request was invalid or malformed.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5df22ff6-c51b-4253-994b-911676f6ec47" }, { "id": "3bf88dfe-31ac-4da5-9f08-e25e6aa9939e", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-3bf88dfe-31ac-4da5-9f08-e25e6aa9939e" }, { "id": "c5a40df3-c5de-4f75-b567-70695d3025ce", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers", ":manager_id" ], "variable": [ { "key": "applicant_id" }, { "key": "manager_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-c5a40df3-c5de-4f75-b567-70695d3025ce" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-89f86a36-34b9-4117-9a05-a2c620c60ac9" } ], "id": "f599ecaf-4802-4ed3-9d75-cf61e0aa9de1", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-f599ecaf-4802-4ed3-9d75-cf61e0aa9de1" }, { "name": "Add Manager on Applicant", "id": "6b091689-fb9a-4c7a-85e0-d15dc926b9a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "a14f169f-7129-4c96-9893-32e76e3ff833", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to assign managers to an applicant. The API will return the saved manager data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nperson_id \n 158674 \n Integer \n Yes" }, "response": [ { "id": "b6510938-6b85-4797-b86d-d6be40434a47", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b6510938-6b85-4797-b86d-d6be40434a47" }, { "id": "72507340-6123-4c5c-9163-efb29ed43ea4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-72507340-6123-4c5c-9163-efb29ed43ea4" }, { "id": "76a0803c-70f4-4e68-b403-a689ed3fa6ce", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-76a0803c-70f4-4e68-b403-a689ed3fa6ce" }, { "id": "ecd94870-ce0b-493d-846f-d93bf785a1b0", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ecd94870-ce0b-493d-846f-d93bf785a1b0" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6b091689-fb9a-4c7a-85e0-d15dc926b9a8" } ], "id": "0d84ee0d-5458-4b44-997f-52e0e96b6665", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-0d84ee0d-5458-4b44-997f-52e0e96b6665" }, { "name": "credit_checks", "item": [ { "name": "List Credit Checks on Applicant", "id": "8f487125-4788-4bf1-87fc-8f31cc264e6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/credit_checks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "credit_checks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "33087353-e7a6-46e2-8706-8a94cc325243", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of credit checks associated with the given applicant ID." }, "response": [ { "id": "5f4fefff-255c-4a82-b2c2-43f5d4b5dc6a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/credit_checks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "credit_checks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5f4fefff-255c-4a82-b2c2-43f5d4b5dc6a" }, { "id": "1c06b23a-722a-447e-94b6-29e0f25f1eac", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/credit_checks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "credit_checks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-1c06b23a-722a-447e-94b6-29e0f25f1eac" }, { "id": "43d75d1d-3e70-4716-a931-e66f2958a9f6", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/credit_checks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "credit_checks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-43d75d1d-3e70-4716-a931-e66f2958a9f6" }, { "id": "f489cea2-7370-41e0-976d-7874f3861196", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/credit_checks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "credit_checks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-f489cea2-7370-41e0-976d-7874f3861196" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8f487125-4788-4bf1-87fc-8f31cc264e6b" } ], "id": "27b0c12e-0df8-41f0-8f27-1d0ca537a943", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-27b0c12e-0df8-41f0-8f27-1d0ca537a943" }, { "name": "conversation_recipients", "item": [ { "name": "Get Recipients for Applicant", "id": "21ec09e7-334f-4972-8871-2c1d23d37029", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversation_recipients" ], "variable": [ { "id": "d7c24900-6927-41b6-87cc-339254c1c582", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of conversation recipients associated with the given applicant ID." }, "response": [ { "id": "6cdeedb6-3f12-4213-886c-a76e2303dc65", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversation_recipients" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6cdeedb6-3f12-4213-886c-a76e2303dc65" }, { "id": "084b05f8-dd57-4519-9692-e672a7b4754f", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversation_recipients" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-084b05f8-dd57-4519-9692-e672a7b4754f" }, { "id": "1b3ae046-d8a0-4652-a520-65a1a931b931", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversation_recipients" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-1b3ae046-d8a0-4652-a520-65a1a931b931" }, { "id": "fe055929-9bc2-47e7-a132-7deb0472dd18", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversation_recipients" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-fe055929-9bc2-47e7-a132-7deb0472dd18" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-21ec09e7-334f-4972-8871-2c1d23d37029" } ], "id": "9e1ba660-f58d-40da-8817-00dd8f4edbd5", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-9e1ba660-f58d-40da-8817-00dd8f4edbd5" }, { "name": "conversations", "item": [ { "name": "List Conversations On Applicant", "id": "ab9ecf25-5dca-4b7e-9847-74efa6fd4244", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "41b6e5da-31bf-4f37-94a8-ad86e0ebbb7d", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of conversations associated with the given applicant ID." }, "response": [ { "id": "510b4dbf-9b95-4760-a57b-d300022f65ca", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-510b4dbf-9b95-4760-a57b-d300022f65ca" }, { "id": "9785aba6-f985-4a1a-a62c-f978cbe13a69", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-9785aba6-f985-4a1a-a62c-f978cbe13a69" }, { "id": "636d4dd8-a2a9-46e7-ab91-248da70ac10e", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-636d4dd8-a2a9-46e7-ab91-248da70ac10e" }, { "id": "08ed79d6-dff5-40c6-827f-65e80ce56501", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-08ed79d6-dff5-40c6-827f-65e80ce56501" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ab9ecf25-5dca-4b7e-9847-74efa6fd4244" }, { "name": "Create Conversation On Applicant", "id": "f4b67de0-f2ae-4445-a5bb-40ce5008655f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "d7cf3a8d-3d77-4010-934f-f41eee7a0ed7", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to create a new conversation related to a\u00a0 applicant . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" }, "response": [ { "id": "f9b920d6-1181-4823-b630-95ea4318f440", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-f9b920d6-1181-4823-b630-95ea4318f440" }, { "id": "96f9cfca-2309-498d-a691-95660af965c4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-96f9cfca-2309-498d-a691-95660af965c4" }, { "id": "cadb620b-d5e4-4e54-a43f-65164d2c4327", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-cadb620b-d5e4-4e54-a43f-65164d2c4327" }, { "id": "a8eee08e-7d52-4aa0-8e7c-6b8535d5dc0d", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a8eee08e-7d52-4aa0-8e7c-6b8535d5dc0d" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-f4b67de0-f2ae-4445-a5bb-40ce5008655f" } ], "id": "12e3b0ab-4bc3-45f6-af78-c57cc57b3c9b", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-12e3b0ab-4bc3-45f6-af78-c57cc57b3c9b" }, { "name": "viewings", "item": [ { "name": "List Viewings On Applicant", "id": "662d352e-b88c-4de4-bbf3-7667ca619754", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "37c1c6f7-0faa-48c3-a67c-42c6a3ee836c", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of viewings associated with the given applicant ID." }, "response": [ { "id": "a60ae1fe-393f-47fa-a277-91b3b5590dc8", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a60ae1fe-393f-47fa-a277-91b3b5590dc8" }, { "id": "cdffae5d-4cbd-49ff-a6fb-f1028c4cbcf3", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-cdffae5d-4cbd-49ff-a6fb-f1028c4cbcf3" }, { "id": "48769a38-6680-4251-bc8f-bbc67a49cca8", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-48769a38-6680-4251-bc8f-bbc67a49cca8" }, { "id": "41aa15ad-71c4-4134-8ed8-5edddee9a707", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-41aa15ad-71c4-4134-8ed8-5edddee9a707" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-662d352e-b88c-4de4-bbf3-7667ca619754" }, { "name": "Add Viewing On Applicant", "id": "6abcb77d-b4c6-4374-aa51-d0f91167da08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"unit_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "e1a5a08b-8a34-4a8a-a27a-011b0e0be617", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to create a new viewing record for the\u00a0 applicant . The API will return the saved data and a unique applicant ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nunit_id \n 123 \n Integer \n\nYes \n\nviewing_date \n 2019-05-28 \n Date \n\nNo \n\nviewing_time \n 00:00 \n Time \n\nNo \n\noffer_amount \n 250.00 \n Float \n\nNo \n\noffer_frequency \n Week \n Enum \n Month \n No \n\nmove_in_date \n 2019-07-01 \n Date \n\nNo \n\nassigned_to_ids \n [123,124] \n Array (Integer) \n\nNo \n\nsource \n My website \n Simple \n\nNo \n\nnotes \n Landlord will be present for this viewing. \n String \n\nNo" }, "response": [ { "id": "c56a3519-05df-4bc6-8073-ea33e43781f3", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"unit_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-c56a3519-05df-4bc6-8073-ea33e43781f3" }, { "id": "4fd76e8a-ca49-4fa2-8723-eab4dc7ddf84", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"unit_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4fd76e8a-ca49-4fa2-8723-eab4dc7ddf84" }, { "id": "79d496c0-cb73-483d-b8c5-2c1a142a2b9e", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"unit_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-79d496c0-cb73-483d-b8c5-2c1a142a2b9e" }, { "id": "770e0859-6ee5-471b-8119-9f1c63730abd", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"unit_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "viewings" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-770e0859-6ee5-471b-8119-9f1c63730abd" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6abcb77d-b4c6-4374-aa51-d0f91167da08" } ], "id": "21cf66c0-2e6e-41fa-bd04-1401978a7cd1", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-21cf66c0-2e6e-41fa-bd04-1401978a7cd1" }, { "name": "notes", "item": [ { "name": "{note_id}", "item": [ { "name": "View Note On Applicant", "id": "748e69df-80ee-4d28-bca4-f6233bb68a14", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "id": "c66456f4-2b40-4129-9d03-86b6ec7b0c54", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." }, { "id": "b93303ce-7c14-4c7c-99f7-86f3c7051e5f", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This API endpoint retrieves the details of a single note , identified by its unique id ." }, "response": [ { "id": "8c4c31d9-c61f-44ec-89b7-80afe0ebc625", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8c4c31d9-c61f-44ec-89b7-80afe0ebc625" }, { "id": "a9d20063-6cb5-4752-8dd8-f8e3c1838c23", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a9d20063-6cb5-4752-8dd8-f8e3c1838c23" }, { "id": "c304ef62-fc2a-41d9-ad90-b96f5f898704", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-c304ef62-fc2a-41d9-ad90-b96f5f898704" }, { "id": "80299d18-8f4b-413d-a817-86d768c56534", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-80299d18-8f4b-413d-a817-86d768c56534" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-748e69df-80ee-4d28-bca4-f6233bb68a14" }, { "name": "Update Note On Applicant", "id": "a7d273cb-7355-4800-8713-53d5f69f71d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "fbe38a6e-5f3f-4088-b7f8-7073101fef04", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." }, { "id": "a134eecb-a338-4d33-960c-434e4a6dc01f", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No" }, "response": [ { "id": "7dd41b42-4153-4def-b26a-0a750b657aff", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-7dd41b42-4153-4def-b26a-0a750b657aff" }, { "id": "7ea453c7-18be-43a4-bf85-d12d8f6f26a0", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-7ea453c7-18be-43a4-bf85-d12d8f6f26a0" }, { "id": "4db5b661-4fa1-416e-8bcf-a0412199380e", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4db5b661-4fa1-416e-8bcf-a0412199380e" }, { "id": "412a738c-bd63-40a4-8263-aa24c1c2ba4c", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-412a738c-bd63-40a4-8263-aa24c1c2ba4c" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a7d273cb-7355-4800-8713-53d5f69f71d8" }, { "name": "Delete Note On Applicant", "id": "a9d1f3a9-f156-451d-9ef6-638a15541c6a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "id": "0e272c52-c4c3-4748-b7fd-2029b9d94d50", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." }, { "id": "b0b35072-4d94-44f2-bab6-ce1c1bb80481", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint deletes an existing note using the note id ." }, "response": [ { "id": "70e295ff-a30e-4d70-b967-56b9734cd732", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-70e295ff-a30e-4d70-b967-56b9734cd732" }, { "id": "2f3e7505-db11-4142-9864-b3399ec916f4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-2f3e7505-db11-4142-9864-b3399ec916f4" }, { "id": "e2617608-4f4a-4fa0-a010-6116a072c586", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-e2617608-4f4a-4fa0-a010-6116a072c586" }, { "id": "4fe8aa82-9f3f-4351-b078-92d7bf97fe18", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes", ":note_id" ], "variable": [ { "key": "applicant_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4fe8aa82-9f3f-4351-b078-92d7bf97fe18" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a9d1f3a9-f156-451d-9ef6-638a15541c6a" } ], "id": "56965617-2f96-455c-b746-569e8c0c568f", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-56965617-2f96-455c-b746-569e8c0c568f" }, { "name": "List Notes On Applicant", "id": "0f699776-c2d0-4b1d-9ec7-78e71ce5cc39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "afbe767c-d56e-4188-a2f4-1fa7252def65", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of notes associated with the given applicant ID." }, "response": [ { "id": "915ba79d-bcee-441c-a908-fb3fcc3cc506", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-915ba79d-bcee-441c-a908-fb3fcc3cc506" }, { "id": "4e76c115-12ac-4f4b-9aae-6f58abf583d4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4e76c115-12ac-4f4b-9aae-6f58abf583d4" }, { "id": "d77bd9ed-c47c-4868-a240-2c1191f924fc", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-d77bd9ed-c47c-4868-a240-2c1191f924fc" }, { "id": "5f670917-1c27-42c6-9e67-b48849eccef6", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5f670917-1c27-42c6-9e67-b48849eccef6" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-0f699776-c2d0-4b1d-9ec7-78e71ce5cc39" }, { "name": "Add Note On Applicant", "id": "8ea817da-9a00-47b2-b1b5-3cd378589df2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "ed850a70-1b2d-4da6-af1f-3cb4a8a4a3e4", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to create a new note record for the applicant . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes" }, "response": [ { "id": "039cc0f5-cf1e-4954-b5e8-6dfb4e5275f9", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-039cc0f5-cf1e-4954-b5e8-6dfb4e5275f9" }, { "id": "ab446640-bad5-4e28-9770-c43c9f633b26", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ab446640-bad5-4e28-9770-c43c9f633b26" }, { "id": "18d0c5d7-e87d-40a0-a00d-cc73b649e116", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-18d0c5d7-e87d-40a0-a00d-cc73b649e116" }, { "id": "058bb508-fbd8-41cf-a3dc-3a41cb6262e9", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-058bb508-fbd8-41cf-a3dc-3a41cb6262e9" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8ea817da-9a00-47b2-b1b5-3cd378589df2" } ], "id": "1159707b-89ac-4613-b8d0-facd415ec5a8", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-1159707b-89ac-4613-b8d0-facd415ec5a8" }, { "name": "tags", "item": [ { "name": "List Tags on Applicant", "id": "d49b96cb-9410-4c2c-b535-2ca4655b0466", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "9af6b192-aba6-4e45-9c35-0ec474b17360", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint retrieves a list of tags associated with the given applicant ID." }, "response": [ { "id": "aae3a3fa-db65-40fd-8009-e46a27935bd2", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-aae3a3fa-db65-40fd-8009-e46a27935bd2" }, { "id": "339a6c5a-e601-42c7-899c-52e0f2d6d2ab", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-339a6c5a-e601-42c7-899c-52e0f2d6d2ab" }, { "id": "9da16869-e1b9-4b36-8dbb-c961ef0f2207", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-9da16869-e1b9-4b36-8dbb-c961ef0f2207" }, { "id": "6210bb9e-7734-4293-ab45-d58a9355f25b", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6210bb9e-7734-4293-ab45-d58a9355f25b" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-d49b96cb-9410-4c2c-b535-2ca4655b0466" }, { "name": "Tag Applicant", "id": "8eec3a4b-d7a8-4c56-b636-d2798e6c4ef8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "e0d106a0-dac6-4c91-bb61-a37cc62406ad", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to create a new tag record for the applicant . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, "response": [ { "id": "6c496b38-a414-46d2-a4d6-203ae89edced", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6c496b38-a414-46d2-a4d6-203ae89edced" }, { "id": "24b04f84-0035-434b-a690-44bfe0063bf7", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-24b04f84-0035-434b-a690-44bfe0063bf7" }, { "id": "f1107164-2aae-4753-95ee-60ab84a5bfd4", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-f1107164-2aae-4753-95ee-60ab84a5bfd4" }, { "id": "9cbb6b7d-2fbb-4fbd-a8af-1936cc727880", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-9cbb6b7d-2fbb-4fbd-a8af-1936cc727880" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8eec3a4b-d7a8-4c56-b636-d2798e6c4ef8" } ], "id": "30269808-d05f-42f1-867e-b1dd725fddd8", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-30269808-d05f-42f1-867e-b1dd725fddd8" }, { "name": "untag", "item": [ { "name": "Untag Applicant", "id": "dd5a231c-200e-4ab2-ad09-6ec981319cc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "17baf2e4-4dc6-477a-929f-98d2788a97e5", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to unassign tag record from the applicant . The API will return the saved data and a unique applicant ID. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n \"1234\" \n String \n Yes" }, "response": [ { "id": "7fa1797e-255e-46bd-a98c-57a333f10a0a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-7fa1797e-255e-46bd-a98c-57a333f10a0a" }, { "id": "542efb2c-a8ae-43f8-9df5-903f4a887726", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-542efb2c-a8ae-43f8-9df5-903f4a887726" }, { "id": "ac2eb1e9-ac8f-4dae-b677-6082da7ec0d8", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ac2eb1e9-ac8f-4dae-b677-6082da7ec0d8" }, { "id": "0fd9174f-6aa4-4d85-95ab-3410eee3f799", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-0fd9174f-6aa4-4d85-95ab-3410eee3f799" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-dd5a231c-200e-4ab2-ad09-6ec981319cc4" } ], "id": "4fbe5686-252f-42b5-a320-54bc60bc4b9a", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4fbe5686-252f-42b5-a320-54bc60bc4b9a" }, { "name": "untag_all", "item": [ { "name": "Untag All Applicant Tags", "id": "8a1d0dbc-5866-490d-9b6b-f6d705e600db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "3e8db30e-acb1-4f2b-9370-aa3f6289dda5", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "Use this endpoint to unassign all tags from the\u00a0 applicant ." }, "response": [ { "id": "e3379dab-c8e4-46af-9eda-3bfdeff33d68", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-e3379dab-c8e4-46af-9eda-3bfdeff33d68" }, { "id": "2f4bd20f-2016-42fe-98a6-68325799de77", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-2f4bd20f-2016-42fe-98a6-68325799de77" }, { "id": "ec3912f2-d83b-4a8b-9b99-ef82a4cfd4c6", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ec3912f2-d83b-4a8b-9b99-ef82a4cfd4c6" }, { "id": "1d9aecc9-522d-430e-b23e-b5da53da9598", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-1d9aecc9-522d-430e-b23e-b5da53da9598" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8a1d0dbc-5866-490d-9b6b-f6d705e600db" } ], "id": "b4b96374-5263-45d2-affe-ee3e10f2d008", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b4b96374-5263-45d2-affe-ee3e10f2d008" }, { "name": "View Applicant", "id": "387f8da7-1e9e-4823-a7fa-3e685e09214c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "variable": [ { "id": "1f282298-5f5e-4d82-84ca-4c98f02777a4", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This API endpoint retrieves the details of a single applicant, identified by its unique\u00a0 applicant_id .\n\nUse this endpoint to view the specific details of a applicant." }, "response": [ { "id": "a40e2572-9649-452e-9de0-e503e4af8fae", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a40e2572-9649-452e-9de0-e503e4af8fae" }, { "id": "b279ba94-f0cd-4221-9739-6ab9c5a279a1", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b279ba94-f0cd-4221-9739-6ab9c5a279a1" }, { "id": "ba17055f-37a9-4eb3-b2f8-7f86c47adb7c", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ba17055f-37a9-4eb3-b2f8-7f86c47adb7c" }, { "id": "0ccd6ae0-06af-478a-9f86-af0e568d4b2d", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants/:applicant_id", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-0ccd6ae0-06af-478a-9f86-af0e568d4b2d" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-387f8da7-1e9e-4823-a7fa-3e685e09214c" }, { "name": "Update Applicant", "id": "23e84b03-aa18-4b43-ae31-e75adc37357c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "id": "b94e2659-c745-4eff-afbc-5ae994290955", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint updates an existing unit using the same fields as the 'Add Applicant' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the applicant in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\ntitle \n Mr \n Enum \n Mr \n No \n\nfirst_name \n Ryan \n String \n\nNo \n\nlast_name \n Cullen \n String \n\nNo \n\ndate_of_birth \n 1995-05-28 \n Date \n\nNo \n\ngender \n Other \n Enum \n Male \n No \n\ncitizen_type \n UK Citizen \n Enum \n\nNo \n\nemail \n myemail@example.com \n Email \n\nNo \n\ncompany_name \n Arthur Online \n String \n\nNo \n\ncompany_address_name \n Arthur Main Office \n String \n\nNo \n\ncompany_address1 \n comp line 1 \n String \n\nNo \n\ncompany_address2 \n comp line 2 \n String \n\nNo \n\ncompany_city \n compcity \n String \n\nNo \n\ncompany_postcode \n C0MP 123 \n String \n\nNo \n\ncompany_county \n comp hertfordshire \n String \n\nNo \n\ncompany_country \n 51 \n Enum \n\nNo \n\nphone_home \n 13597352 \n String \n\nNo \n\nphone_work \n 0159876589 \n String \n\nNo \n\nmobile \n 07726895134 \n String \n\nNo \n\nresidential_number \n 11236659 \n String \n\nNo \n\nvisa_number \n 1346dq89 \n String \n\nNo \n\nvisa_years \n 3 \n String \n\nNo \n\nvisa_type \n Tier 2 \n Enum \n\nNo \n\ncountry_of_origin \n original country \n String \n\nNo \n\nni_number \n ab 12 34 5f \n String \n\nNo \n\nhousing_benefit_council \n herts council \n String \n\nNo \n\nhousing_benefit_number \n 1346 \n String \n\nNo \n\nbank_name \n bnk name \n String \n\nNo \n\nbank_address1 \n bank line 1 \n String \n\nNo \n\nbank_address2 \n bank line 2 \n String \n\nNo \n\nbank_city \n bankcity \n String \n\nNo \n\nbank_county \n bank herts \n String \n\nNo \n\nbank_postcode \n B4N K12 \n String \n\nNo \n\nkin_first_name \n next-of \n String \n\nNo \n\nkin_last_name \n kin \n String \n\nNo \n\nkin_mobile \n 4512325178 \n String \n\nNo \n\nkin_phone_work \n 996832145 \n String \n\nNo \n\nstudent_status \n full time \n Enum \n Full Time \n No \n\nuniversity \n viking university \n String \n\nNo \n\ncourse_name \n viking studies \n String \n\nNo \n\ncourse_id \n MC1685 \n String \n\nNo \n\ncourse_year \n 3 \n String \n\nNo \n\nemployment_company_name \n emp company name \n String \n\nNo \n\nemployment_address1 \n emp line 1 \n String \n\nNo \n\nemployment_address2 \n emp line 2 \n String \n\nNo \n\nemployment_city \n emp city \n String \n\nNo \n\nemployment_postcode \n 3MP C0NT \n String \n\nNo \n\nemployment_county \n emp herts \n String \n\nNo \n\nemployment_contact_name \n employed contact \n String \n\nNo \n\nemployment_contact_number \n 968235174 \n String \n\nNo \n\nemployment_salary \n 21000 \n String \n\nNo \n\nemployment_length \n 3 years \n String \n\nNo \n\nref_name \n ref name \n String \n\nNo \n\nref_address1 \n ref line 1 \n String \n\nNo \n\nref_address2 \n ref line 2 \n String \n\nNo \n\nref_city \n ref Stevenage \n String \n\nNo \n\nref_county \n ref Hertfordshire \n String \n\nNo \n\nref_postcode \n R3F 8AW \n String \n\nNo \n\nref_contact_number \n 134679825 \n String \n\nNo \n\nref_relation \n mother \n String \n\nNo \n\nnumber_of_sharers \n 3 \n String \n\nNo \n\nsource \n 3 \n Simple \n\nNo \n\nmanager_note \n MANAGER NOTES \n String \n\nNo \n\napplicant_note \n TEST NOTE \n String \n\nNo \n\ntags \n [\"tag1\"] \n Array(String) \n\nNo" }, "response": [ { "id": "6ced4df1-2fc0-4614-9096-4e3c8109833b", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-6ced4df1-2fc0-4614-9096-4e3c8109833b" }, { "id": "fd266546-6882-4c83-bb93-1bc98e8647aa", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-fd266546-6882-4c83-bb93-1bc98e8647aa" }, { "id": "0d15542f-4f5d-4fd4-a918-20b3447f8010", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-0d15542f-4f5d-4fd4-a918-20b3447f8010" }, { "id": "406db8ec-8034-46db-ab1d-90f98b97ff13", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants/:applicant_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants", ":applicant_id" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-406db8ec-8034-46db-ab1d-90f98b97ff13" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-23e84b03-aa18-4b43-ae31-e75adc37357c" } ], "id": "21935d9f-9930-4e37-b99c-ed5df9947035", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-21935d9f-9930-4e37-b99c-ed5df9947035" }, { "name": "List Applicants", "id": "cffc3103-9a4a-403d-85f4-e36195ce4858", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/applicants?email=&status=&conditions=&tags=&created_date_from=&created_date_to=&new_applicants_today=&number_of_sharers=&source=&assign_to=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Filter by applicant email", "key": "email", "value": "" }, { "description": "Filter by status (Tenant, Active, Inactive or custom created statuses)", "key": "status", "value": "" }, { "description": "Filter by pre-defined conditions (with-viewing, without-viewing, empty)", "key": "conditions", "value": "" }, { "description": "Filter by tags associated with the applicant, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_from", "value": "" }, { "description": "Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_to", "value": "" }, { "description": "To display only recent applicants, set this to true", "key": "new_applicants_today", "value": "" }, { "description": "Filter applicants by the number of sharers", "key": "number_of_sharers", "value": "" }, { "description": "Filter list by applicant source name", "key": "source", "value": "" }, { "description": "Filter list by Manager ID", "key": "assign_to", "value": "" }, { "description": "Filter list by a keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] }, "description": "This endpoint retrieves a list of applicants. The enterprise package is required to view/edit the matched_unit_ids array list.\n\nSee available filters below to customize the list of applicants returned." }, "response": [ { "id": "9170d9ea-17d7-4530-901f-2723e462982a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants?email=&status=&conditions=&tags=&created_date_from=&created_date_to=&new_applicants_today=&number_of_sharers=&source=&assign_to=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Filter by applicant email", "key": "email", "value": "" }, { "description": "Filter by status (Tenant, Active, Inactive or custom created statuses)", "key": "status", "value": "" }, { "description": "Filter by pre-defined conditions (with-viewing, without-viewing, empty)", "key": "conditions", "value": "" }, { "description": "Filter by tags associated with the applicant, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_from", "value": "" }, { "description": "Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_to", "value": "" }, { "description": "To display only recent applicants, set this to true", "key": "new_applicants_today", "value": "" }, { "description": "Filter applicants by the number of sharers", "key": "number_of_sharers", "value": "" }, { "description": "Filter list by applicant source name", "key": "source", "value": "" }, { "description": "Filter list by Manager ID", "key": "assign_to", "value": "" }, { "description": "Filter list by a keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-9170d9ea-17d7-4530-901f-2723e462982a" }, { "id": "8786128b-4822-4ba7-aa28-777862138f12", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants?email=&status=&conditions=&tags=&created_date_from=&created_date_to=&new_applicants_today=&number_of_sharers=&source=&assign_to=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Filter by applicant email", "key": "email", "value": "" }, { "description": "Filter by status (Tenant, Active, Inactive or custom created statuses)", "key": "status", "value": "" }, { "description": "Filter by pre-defined conditions (with-viewing, without-viewing, empty)", "key": "conditions", "value": "" }, { "description": "Filter by tags associated with the applicant, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_from", "value": "" }, { "description": "Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_to", "value": "" }, { "description": "To display only recent applicants, set this to true", "key": "new_applicants_today", "value": "" }, { "description": "Filter applicants by the number of sharers", "key": "number_of_sharers", "value": "" }, { "description": "Filter list by applicant source name", "key": "source", "value": "" }, { "description": "Filter list by Manager ID", "key": "assign_to", "value": "" }, { "description": "Filter list by a keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-8786128b-4822-4ba7-aa28-777862138f12" }, { "id": "2a5ee60f-631d-4be1-a109-d3c65e89a6d7", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants?email=&status=&conditions=&tags=&created_date_from=&created_date_to=&new_applicants_today=&number_of_sharers=&source=&assign_to=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Filter by applicant email", "key": "email", "value": "" }, { "description": "Filter by status (Tenant, Active, Inactive or custom created statuses)", "key": "status", "value": "" }, { "description": "Filter by pre-defined conditions (with-viewing, without-viewing, empty)", "key": "conditions", "value": "" }, { "description": "Filter by tags associated with the applicant, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_from", "value": "" }, { "description": "Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_to", "value": "" }, { "description": "To display only recent applicants, set this to true", "key": "new_applicants_today", "value": "" }, { "description": "Filter applicants by the number of sharers", "key": "number_of_sharers", "value": "" }, { "description": "Filter list by applicant source name", "key": "source", "value": "" }, { "description": "Filter list by Manager ID", "key": "assign_to", "value": "" }, { "description": "Filter list by a keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-2a5ee60f-631d-4be1-a109-d3c65e89a6d7" }, { "id": "d052f1c7-a124-4541-b981-84a4825cbf10", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/applicants?email=&status=&conditions=&tags=&created_date_from=&created_date_to=&new_applicants_today=&number_of_sharers=&source=&assign_to=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Filter by applicant email", "key": "email", "value": "" }, { "description": "Filter by status (Tenant, Active, Inactive or custom created statuses)", "key": "status", "value": "" }, { "description": "Filter by pre-defined conditions (with-viewing, without-viewing, empty)", "key": "conditions", "value": "" }, { "description": "Filter by tags associated with the applicant, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_from", "value": "" }, { "description": "Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "created_date_to", "value": "" }, { "description": "To display only recent applicants, set this to true", "key": "new_applicants_today", "value": "" }, { "description": "Filter applicants by the number of sharers", "key": "number_of_sharers", "value": "" }, { "description": "Filter list by applicant source name", "key": "source", "value": "" }, { "description": "Filter list by Manager ID", "key": "assign_to", "value": "" }, { "description": "Filter list by a keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-d052f1c7-a124-4541-b981-84a4825cbf10" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-cffc3103-9a4a-403d-85f4-e36195ce4858" }, { "name": "Add Applicant", "id": "4a980b20-08c6-4686-8005-b31691aaac03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_status\": \"\",\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ] }, "description": "Use this endpoint to create a new applicant. The API will return the saved data and a unique Applicant ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\napplicant_status \n Active \n String \n\nNo \n\ntitle \n Mr \n Enum \n Mr \n No \n\nfirst_name \n Ryan \n String \n\nNo \n\nlast_name \n Cullen \n String \n\nNo \n\ndate_of_birth \n 1995-05-28 \n Date \n\nNo \n\ngender \n Other \n Enum \n Male \n No \n\ncitizen_type \n UK Citizen \n Enum \n\nNo \n\nemail \n myemail@example.com \n Email \n\nNo \n\ncompany_name \n Arthur Online \n String \n\nNo \n\ncompany_address_name \n Arthur Main Office \n String \n\nNo \n\ncompany_address1 \n comp line 1 \n String \n\nNo \n\ncompany_address2 \n comp line 2 \n String \n\nNo \n\ncompany_city \n compcity \n String \n\nNo \n\ncompany_postcode \n C0MP 123 \n String \n\nNo \n\ncompany_county \n comp hertfordshire \n String \n\nNo \n\ncompany_country \n 51 \n Enum \n\nNo \n\nphone_home \n 13597352 \n String \n\nNo \n\nphone_work \n 0159876589 \n String \n\nNo \n\nmobile \n 07726895134 \n String \n\nNo \n\nresidential_number \n 11236659 \n String \n\nNo \n\nvisa_number \n 1346dq89 \n String \n\nNo \n\nvisa_years \n 3 \n String \n\nNo \n\nvisa_type \n Tier 2 \n Enum \n\nNo \n\ncountry_of_origin \n original country \n String \n\nNo \n\nni_number \n ab 12 34 5f \n String \n\nNo \n\nhousing_benefit_council \n herts council \n String \n\nNo \n\nhousing_benefit_number \n 1346 \n String \n\nNo \n\nbank_name \n bnk name \n String \n\nNo \n\nbank_address1 \n bank line 1 \n String \n\nNo \n\nbank_address2 \n bank line 2 \n String \n\nNo \n\nbank_city \n bankcity \n String \n\nNo \n\nbank_county \n bank herts \n String \n\nNo \n\nbank_postcode \n B4N K12 \n String \n\nNo \n\nkin_first_name \n next-of \n String \n\nNo \n\nkin_last_name \n kin \n String \n\nNo \n\nkin_mobile \n 4512325178 \n String \n\nNo \n\nkin_phone_work \n 996832145 \n String \n\nNo \n\nstudent_status \n full time \n Enum \n Full Time \n No \n\nuniversity \n viking university \n String \n\nNo \n\ncourse_name \n viking studies \n String \n\nNo \n\ncourse_id \n MC1685 \n String \n\nNo \n\ncourse_year \n 3 \n String \n\nNo \n\nemployment_company_name \n emp company name \n String \n\nNo \n\nemployment_address1 \n emp line 1 \n String \n\nNo \n\nemployment_address2 \n emp line 2 \n String \n\nNo \n\nemployment_city \n emp city \n String \n\nNo \n\nemployment_postcode \n 3MP C0NT \n String \n\nNo \n\nemployment_county \n emp herts \n String \n\nNo \n\nemployment_contact_name \n employed contact \n String \n\nNo \n\nemployment_contact_number \n 968235174 \n String \n\nNo \n\nemployment_salary \n 21000 \n String \n\nNo \n\nemployment_length \n 3 years \n String \n\nNo \n\nguarantor_first_name \n Jason \n String \n\nNo \n\nguarantor_last_name \n Doe \n String \n\nNo \n\nguarantor_date_of_birth \n 1968-05-08 \n String \n\nNo \n\nguarantor_address1 \n 123 Fake Street \n String \n\nNo \n\nguarantor_address2 \n 123 Fake Street \n String \n\nNo \n\nguarantor_city \n Notreal \n String \n\nNo \n\nguarantor_postcode \n ABC 123 \n String \n\nNo \n\nguarantor_county \n Doeshire \n String \n\nNo \n\nguarantor_country \n United Kingdom \n String \n\nNo \n\nguarantor_phone_home \n 12345 678900 \n String \n\nNo \n\nguarantor_phone_work \n 01234 567890 \n String \n\nNo \n\nguarantor_mobile \n 07000 000000 \n String \n\nNo \n\nguarantor_email \n example@email.com \n String \n\nNo \n\nguarantor_relation \n Father \n String \n\nNo \n\nguarantor_home_owner \n Home Owner Outright \n String \n\nNo \n\nguarantor_profession \n Professional \n String \n\nNo \n\nref_name \n ref name \n String \n\nNo \n\nref_address1 \n ref line 1 \n String \n\nNo \n\nref_address2 \n ref line 2 \n String \n\nNo \n\nref_city \n ref Stevenage \n String \n\nNo \n\nref_county \n ref Hertfordshire \n String \n\nNo \n\nref_postcode \n R3F 8AW \n String \n\nNo \n\nref_contact_number \n 134679825 \n String \n\nNo \n\nref_relation \n mother \n String \n\nNo \n\nnumber_of_sharers \n 3 \n String \n\nNo \n\nsource \n 3 \n Simple \n\nNo \n\nmanager_note \n MANAGER NOTES \n String \n\nNo \n\napplicant_note \n TEST NOTE \n String \n\nNo \n\ntags \n [\"tag1\"] \n Array(String) \n\nNo" }, "response": [ { "id": "a1969db8-ba9a-4582-aa91-f12035b55205", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"applicant_status\": \"\",\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a1969db8-ba9a-4582-aa91-f12035b55205" }, { "id": "4cadec8c-bc81-4990-99fc-6e03bae75944", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"applicant_status\": \"\",\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4cadec8c-bc81-4990-99fc-6e03bae75944" }, { "id": "a8f90221-ca4a-4dca-8c6e-90a805aa8f08", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"applicant_status\": \"\",\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a8f90221-ca4a-4dca-8c6e-90a805aa8f08" }, { "id": "a67655e8-19d0-465d-bee6-321cd0f52604", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"applicant_status\": \"\",\n \"title\": \"Mr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"Male\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"Full Time\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"number_of_sharers\": \"\",\n \"source\": \"\",\n \"manager_note\": \"\",\n \"applicant_note\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicants" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-a67655e8-19d0-465d-bee6-321cd0f52604" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-4a980b20-08c6-4686-8005-b31691aaac03" } ], "id": "ea4049d9-f7cb-48ae-ab57-8326c30e86fd", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-ea4049d9-f7cb-48ae-ab57-8326c30e86fd" }, { "name": "applicant", "item": [ { "name": "{applicant_id}", "item": [ { "name": "status", "item": [ { "name": "Update Applicant Status", "id": "7a76ff24-136c-417e-8961-21d934237c59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicant/:applicant_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicant", ":applicant_id", "status" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "id": "aa8bde2b-638d-45d1-83be-2bc79526e929", "key": "applicant_id", "value": "", "description": "(Required) Arthur applicant id." } ] }, "description": "This endpoint updates an existing applicants status. The API will return the updated data for the applicant in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nstatus \n \"Tenant\" \n String \n Yes" }, "response": [ { "id": "e0d30ea3-c886-49e3-911e-faa4ea31b418", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicant/:applicant_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicant", ":applicant_id", "status" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-e0d30ea3-c886-49e3-911e-faa4ea31b418" }, { "id": "23c7fb7b-7d34-471f-bea4-1078590e1a7e", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicant/:applicant_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicant", ":applicant_id", "status" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-23c7fb7b-7d34-471f-bea4-1078590e1a7e" }, { "id": "473abc67-e21c-4f9a-a733-4c102909c4ec", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicant/:applicant_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicant", ":applicant_id", "status" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-473abc67-e21c-4f9a-a733-4c102909c4ec" }, { "id": "5d46fa87-14dd-4409-8d64-07f1d8d1fff1", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/applicant/:applicant_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "applicant", ":applicant_id", "status" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "applicant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-5d46fa87-14dd-4409-8d64-07f1d8d1fff1" } ], "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-7a76ff24-136c-417e-8961-21d934237c59" } ], "id": "b4068af7-66b1-47bf-a8b6-ec34501b91dc", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-b4068af7-66b1-47bf-a8b6-ec34501b91dc" } ], "id": "97245815-46c4-4754-97b4-d112f01ed98b", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-97245815-46c4-4754-97b4-d112f01ed98b" } ], "id": "d9fce6fb-0e38-49ab-ad3f-ad279d37f576", "createdAt": "2026-07-28T01:05:05.000Z", "updatedAt": "2026-07-28T01:05:05.000Z", "uid": "35240-d9fce6fb-0e38-49ab-ad3f-ad279d37f576" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "redirect_uri", "value": "https://auth.arthuronline.co.uk/oauth/token", "type": "string" }, { "key": "accessTokenUrl", "value": "https://auth.arthuronline.co.uk/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://auth.arthuronline.co.uk/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.arthuronline.co.uk/v2" } ] }