{ "info": { "_postman_id": "3c4d44ca-3e23-40b6-a065-e57522732118", "name": "pinch-api-contacts", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:36:15.000Z", "updatedAt": "2026-07-28T02:36:15.000Z", "lastUpdatedBy": "35240", "uid": "35240-3c4d44ca-3e23-40b6-a065-e57522732118" }, "item": [ { "name": "contacts", "item": [ { "name": "{id}", "item": [ { "name": "Delete Contact", "id": "3ea80d29-309e-4332-8b17-41d10a30de02", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "id": "8d3e8fc8-2c21-458c-a53a-cdc76b7cab30", "key": "id", "value": "", "description": "(Required) The contact identifier" } ] }, "description": "Deletes a contact by ID." }, "response": [ { "id": "5e2f1fc5-83cb-429f-96c7-9287ae66e72b", "name": "200", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"Result\": {\n \"value\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-5e2f1fc5-83cb-429f-96c7-9287ae66e72b" }, { "id": "e32f5bda-0a6c-4b61-b588-bb8721ab4480", "name": "400", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": {},\n \"formattedMessageArguments\": {},\n \"formattedMessagePlaceholderValues\": {},\n \"resourceName\": {}\n },\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": {},\n \"formattedMessageArguments\": {},\n \"formattedMessagePlaceholderValues\": {},\n \"resourceName\": {}\n }\n]", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-e32f5bda-0a6c-4b61-b588-bb8721ab4480" } ], "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-3ea80d29-309e-4332-8b17-41d10a30de02" }, { "name": "Get Contact", "id": "13694913-31c7-4bf4-b18f-34fc7dfa6ab5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "id": "a23001bf-2063-410b-80a5-f0b826a54513", "key": "id", "value": "", "description": "(Required) The contact identifier (string identifier starting with `con_`)" } ] }, "description": "Retrieves a single contact by ID." }, "response": [ { "id": "b536c668-1168-4558-872f-3716533fa8b9", "name": "200", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"isUbo\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumberSupplied\": \"\",\n \"driversLicenseSupplied\": \"\",\n \"passportNumberSupplied\": \"\",\n \"contactType\": \"director\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n}", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-b536c668-1168-4558-872f-3716533fa8b9" }, { "id": "36e4d5f3-d5bb-470b-ae85-6616dea4391a", "name": "400", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": {},\n \"formattedMessageArguments\": {},\n \"formattedMessagePlaceholderValues\": {},\n \"resourceName\": {}\n },\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": {},\n \"formattedMessageArguments\": {},\n \"formattedMessagePlaceholderValues\": {},\n \"resourceName\": {}\n }\n]", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-36e4d5f3-d5bb-470b-ae85-6616dea4391a" } ], "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-13694913-31c7-4bf4-b18f-34fc7dfa6ab5" } ], "id": "b5fd2826-dd26-4c37-b43f-468effeea3fb", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-b5fd2826-dd26-4c37-b43f-468effeea3fb" }, { "name": "Get Contacts", "id": "df016181-1d13-4257-8a0e-a77c1d0b78f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts?page=1&pageSize=50&filter=", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page (max 500)", "key": "pageSize", "value": "50" }, { "description": "Search filter", "key": "filter", "value": "" } ] }, "description": "Retrieves a paginated list of contacts for the authenticated merchant." }, "response": [ { "id": "57635578-7d02-4821-bf5b-0af5f04ffee5", "name": "200", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts?page=1&pageSize=50&filter=", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page (max 500)", "key": "pageSize", "value": "50" }, { "description": "Search filter", "key": "filter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalItems\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"isUbo\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumberSupplied\": \"\",\n \"driversLicenseSupplied\": \"\",\n \"passportNumberSupplied\": \"\",\n \"contactType\": \"owner\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n },\n {\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"isUbo\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumberSupplied\": \"\",\n \"driversLicenseSupplied\": \"\",\n \"passportNumberSupplied\": \"\",\n \"contactType\": \"executive\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-57635578-7d02-4821-bf5b-0af5f04ffee5" }, { "id": "cb33e758-1350-4976-9c6c-fdac10f0aaa7", "name": "400", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts?page=1&pageSize=50&filter=", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page (max 500)", "key": "pageSize", "value": "50" }, { "description": "Search filter", "key": "filter", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": \"\",\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": \"\",\n \"formattedMessageArguments\": \"\",\n \"formattedMessagePlaceholderValues\": {\n \"PropertyName\": \"\",\n \"PropertyValue\": \"\"\n },\n \"resourceName\": \"\"\n },\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": \"\",\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": \"\",\n \"formattedMessageArguments\": \"\",\n \"formattedMessagePlaceholderValues\": {\n \"PropertyName\": \"\",\n \"PropertyValue\": \"\"\n },\n \"resourceName\": \"\"\n }\n]", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-cb33e758-1350-4976-9c6c-fdac10f0aaa7" } ], "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-df016181-1d13-4257-8a0e-a77c1d0b78f6" }, { "name": "Create or Update Contact", "id": "3f9db028-b05e-4f2b-b5f3-d0e3c6295569", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contactType\": \"director\",\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumber\": \"\",\n \"passportNumber\": \"\",\n \"passportCountryCode\": \"\",\n \"driversLicenseNumber\": \"\",\n \"driversLicenseState\": \"\",\n \"driversLicenseCountryCode\": \"\",\n \"driversLicenseCardNumber\": \"\",\n \"driversLicenseExpiryDate\": \"\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ] }, "description": "Creates a new contact or updates an existing one. If an `id` is provided in the request body, the contact will be updated; otherwise a new contact will be created." }, "response": [ { "id": "03f5777f-b122-4721-8c2d-10064814c791", "name": "200", "originalRequest": { "method": "POST", "header": [ { "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 \"contactType\": \"director\",\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumber\": \"\",\n \"passportNumber\": \"\",\n \"passportCountryCode\": \"\",\n \"driversLicenseNumber\": \"\",\n \"driversLicenseState\": \"\",\n \"driversLicenseCountryCode\": \"\",\n \"driversLicenseCardNumber\": \"\",\n \"driversLicenseExpiryDate\": \"\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"isUbo\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumberSupplied\": \"\",\n \"driversLicenseSupplied\": \"\",\n \"passportNumberSupplied\": \"\",\n \"contactType\": \"director\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n}", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-03f5777f-b122-4721-8c2d-10064814c791" }, { "id": "e5f17e60-4e29-436d-bfe4-b7e91a042ede", "name": "400", "originalRequest": { "method": "POST", "header": [ { "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 \"contactType\": \"director\",\n \"id\": \"\",\n \"isPrimaryContact\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"streetAddress\": \"\",\n \"suburb\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"governmentNumber\": \"\",\n \"passportNumber\": \"\",\n \"passportCountryCode\": \"\",\n \"driversLicenseNumber\": \"\",\n \"driversLicenseState\": \"\",\n \"driversLicenseCountryCode\": \"\",\n \"driversLicenseCardNumber\": \"\",\n \"driversLicenseExpiryDate\": \"\",\n \"ownership\": \"\",\n \"jobTitle\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": \"\",\n \"formattedMessageArguments\": \"\",\n \"formattedMessagePlaceholderValues\": {\n \"PropertyName\": \"\",\n \"PropertyValue\": {}\n },\n \"resourceName\": \"\"\n },\n {\n \"propertyName\": \"\",\n \"errorMessage\": \"\",\n \"attemptedValue\": {},\n \"customState\": {},\n \"severity\": 0,\n \"errorCode\": \"\",\n \"formattedMessageArguments\": \"\",\n \"formattedMessagePlaceholderValues\": {\n \"PropertyName\": \"\",\n \"PropertyValue\": {}\n },\n \"resourceName\": \"\"\n }\n]", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-e5f17e60-4e29-436d-bfe4-b7e91a042ede" } ], "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-3f9db028-b05e-4f2b-b5f3-d0e3c6295569" } ], "id": "3581a451-2dae-43f8-b47a-b30dc9bc5cc8", "createdAt": "2026-07-28T02:36:16.000Z", "updatedAt": "2026-07-28T02:36:16.000Z", "uid": "35240-3581a451-2dae-43f8-b47a-b30dc9bc5cc8" } ], "auth": { "type": "oauth2" }, "variable": [ { "key": "baseUrl", "value": "https://api.getpinch.com.au/test" } ] }