{ "info": { "_postman_id": "d896bed4-82b6-4345-8ec7-00bd60514171", "name": "Remote Address Details Custom Fields API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "lastUpdatedBy": "35240", "uid": "35240-d896bed4-82b6-4345-8ec7-00bd60514171" }, "item": [ { "name": "v1", "item": [ { "name": "custom-fields", "item": [ { "name": "{custom_field_id}", "item": [ { "name": "values", "item": [ { "name": "{employment_id}", "item": [ { "name": "Show a custom field value", "id": "04236247-b2bd-4990-80b2-454480671992", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "id": "a0bdf670-0007-4b4d-a661-d9037cadb08f", "key": "custom_field_id", "value": "", "description": "(Required) Custom field ID" }, { "id": "b70a9f8d-a5f5-4479-adfe-18368aa35d62", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns a custom field value for a given employment\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |\n" }, "response": [ { "id": "171425c2-0482-4634-a9a8-b89e83ea4aeb", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"custom_field_value\": {\n \"custom_field_id\": \"\",\n \"value\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-171425c2-0482-4634-a9a8-b89e83ea4aeb" }, { "id": "f0f9776a-f55b-404a-ad24-b65e8b8696ce", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-f0f9776a-f55b-404a-ad24-b65e8b8696ce" }, { "id": "a5371208-1fc8-4408-9ae2-473d807d8fdf", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-a5371208-1fc8-4408-9ae2-473d807d8fdf" }, { "id": "e0b09eaf-642c-49ad-ab3a-2cfee9a5d7d1", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-e0b09eaf-642c-49ad-ab3a-2cfee9a5d7d1" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-04236247-b2bd-4990-80b2-454480671992" }, { "name": "Update a Custom Field Value", "id": "5e0fa281-74cb-4aa1-a743-1ca83511be67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "id": "b652cc20-445a-429c-bc2b-8037228ecbd9", "key": "custom_field_id", "value": "", "description": "(Required) Custom field ID" }, { "id": "d62acb0b-471e-4310-a0e2-9543df741f7a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates a custom field value for a given employment.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) |\n" }, "response": [ { "id": "b5cd84e4-f3db-452a-b8de-34c006a0482d", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"custom_field_value\": {\n \"custom_field_id\": \"\",\n \"value\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-b5cd84e4-f3db-452a-b8de-34c006a0482d" }, { "id": "d3db2847-06ac-4106-ad57-fc539c0f8ec3", "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-d3db2847-06ac-4106-ad57-fc539c0f8ec3" }, { "id": "d6b243ae-6bf7-4040-8a49-39dd3ad77274", "name": "Forbidden", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-d6b243ae-6bf7-4040-8a49-39dd3ad77274" }, { "id": "e9abd3ed-51f1-4e37-9ee1-cbbd9e887e1f", "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-e9abd3ed-51f1-4e37-9ee1-cbbd9e887e1f" }, { "id": "58d026ab-21c0-4dc4-bf9c-5ef92521e5cf", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-58d026ab-21c0-4dc4-bf9c-5ef92521e5cf" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-5e0fa281-74cb-4aa1-a743-1ca83511be67" }, { "name": "Update a Custom Field Value", "id": "74be300c-8b9b-4019-bb9f-368bac5c0385", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "id": "c764ca8f-547f-4e49-bfc6-5ddf088329a4", "key": "custom_field_id", "value": "", "description": "(Required) Custom field ID" }, { "id": "047feed2-ec8b-4f19-ac9c-40bd1ecfe33e", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates a custom field value for a given employment.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) |\n" }, "response": [ { "id": "01dc285c-0d9b-4186-9fa7-6a5549e4b2b7", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"custom_field_value\": {\n \"custom_field_id\": \"\",\n \"value\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-01dc285c-0d9b-4186-9fa7-6a5549e4b2b7" }, { "id": "4052e953-cc8b-4859-af89-d40ba0b1609d", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-4052e953-cc8b-4859-af89-d40ba0b1609d" }, { "id": "bbd33786-20b0-4616-b0bd-2740c958c599", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-bbd33786-20b0-4616-b0bd-2740c958c599" }, { "id": "6749478c-9e7f-4621-b225-9aea4a6bcdf8", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-6749478c-9e7f-4621-b225-9aea4a6bcdf8" }, { "id": "6818f130-6be6-4fc6-a566-8ead5afa202e", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields/:custom_field_id/values/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields", ":custom_field_id", "values", ":employment_id" ], "variable": [ { "key": "custom_field_id" }, { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-6818f130-6be6-4fc6-a566-8ead5afa202e" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-74be300c-8b9b-4019-bb9f-368bac5c0385" } ], "id": "15e06e9d-cfa3-4baf-994c-5bf707f6926d", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-15e06e9d-cfa3-4baf-994c-5bf707f6926d" } ], "id": "f0942564-4c55-4769-a110-ee57d8a83f1b", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-f0942564-4c55-4769-a110-ee57d8a83f1b" } ], "id": "6abb0607-fc68-4742-9f0e-30abee23923a", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-6abb0607-fc68-4742-9f0e-30abee23923a" }, { "name": "Lists custom fields definitions", "id": "c3a13654-517a-48ef-9255-e143726f9845", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Returns custom fields definitions\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) |\n" }, "response": [ { "id": "c4d01454-44c4-4fbb-9bf9-f2e822e333f5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"custom_fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"single_select\",\n \"required\": \"\",\n \"visibility_scope\": \"everyone\",\n \"data_entry_access\": \"company_admin_only\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"visibility_scope\": \"everyone\",\n \"data_entry_access\": \"everyone\",\n \"metadata\": {}\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-c4d01454-44c4-4fbb-9bf9-f2e822e333f5" }, { "id": "59de20ef-3a65-42b1-97e5-5d4d0d1a2a49", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-59de20ef-3a65-42b1-97e5-5d4d0d1a2a49" }, { "id": "946199e1-282c-4d75-8d33-ff40d250719e", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-946199e1-282c-4d75-8d33-ff40d250719e" }, { "id": "33d042c6-2dbf-464d-ae37-e85a23569d4c", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-33d042c6-2dbf-464d-ae37-e85a23569d4c" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-c3a13654-517a-48ef-9255-e143726f9845" }, { "name": "Create Custom Field Definition", "id": "2054e24e-1420-43d3-93b1-1b7b8a2ed9be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"data_entry_access\": \"employee_only\",\n \"visibility_scope\": \"company_admin_only\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ] }, "description": "Creates a new custom field definition.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) |\n" }, "response": [ { "id": "543c15be-75dc-45cf-9aac-03d3c5ddaeb2", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"data_entry_access\": \"employee_only\",\n \"visibility_scope\": \"company_admin_only\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"custom_field\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"visibility_scope\": \"everyone\",\n \"data_entry_access\": \"company_admin_only\",\n \"metadata\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-543c15be-75dc-45cf-9aac-03d3c5ddaeb2" }, { "id": "83710d45-cd56-4b10-9407-3f498e7faf00", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"data_entry_access\": \"employee_only\",\n \"visibility_scope\": \"company_admin_only\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-83710d45-cd56-4b10-9407-3f498e7faf00" }, { "id": "709213e9-8ad7-4905-b0d2-c284b0ab07c8", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"data_entry_access\": \"employee_only\",\n \"visibility_scope\": \"company_admin_only\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-709213e9-8ad7-4905-b0d2-c284b0ab07c8" }, { "id": "fb318f02-6833-4be2-8bde-04d10c121155", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"boolean\",\n \"required\": \"\",\n \"data_entry_access\": \"employee_only\",\n \"visibility_scope\": \"company_admin_only\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "custom-fields" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-fb318f02-6833-4be2-8bde-04d10c121155" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-2054e24e-1420-43d3-93b1-1b7b8a2ed9be" } ], "id": "5c7ee8c6-2f48-48eb-a848-f848e0351950", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-5c7ee8c6-2f48-48eb-a848-f848e0351950" }, { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "custom-fields", "item": [ { "name": "List custom field value for an employment", "id": "fad0ad3e-003e-4dc8-ac7c-07e36f7d7421", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "63268274-a521-4f66-864f-2e84585527e5", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns a list of custom field values for a given employment\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |\n" }, "response": [ { "id": "599a5932-107d-4bfb-be48-1844a0ec8fa7", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"custom_field_values\": [\n {\n \"custom_field_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"custom_field_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-599a5932-107d-4bfb-be48-1844a0ec8fa7" }, { "id": "0872a829-aefc-481f-8650-7b2195d316b4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-0872a829-aefc-481f-8650-7b2195d316b4" }, { "id": "d2d6a09b-1321-4dba-be3d-31bfa8ec3c1e", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-d2d6a09b-1321-4dba-be3d-31bfa8ec3c1e" }, { "id": "1cdcc8cf-0a78-4c64-91d6-2a34616bf53e", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/custom-fields?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "custom-fields" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-1cdcc8cf-0a78-4c64-91d6-2a34616bf53e" } ], "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-fad0ad3e-003e-4dc8-ac7c-07e36f7d7421" } ], "id": "f956226a-9d28-4ab4-a666-e08143e7d557", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-f956226a-9d28-4ab4-a666-e08143e7d557" } ], "id": "3d15f04e-4fa7-44d2-a2d0-aecccfa9a7ce", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-3d15f04e-4fa7-44d2-a2d0-aecccfa9a7ce" } ], "id": "324abbec-2101-4552-878b-1b77bedfb80d", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-324abbec-2101-4552-878b-1b77bedfb80d" } ], "id": "0f191d2f-01ad-4216-a627-4888818db46c", "createdAt": "2026-07-28T02:45:26.000Z", "updatedAt": "2026-07-28T02:45:26.000Z", "uid": "35240-0f191d2f-01ad-4216-a627-4888818db46c" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://gateway.remote.com/" } ] }