Welcome to the Prokuria API ๐
Our API enables you to automate and integrate sourcing workflows such as RFQs, RFPs, supplier onboarding, auctions, and event document management directly into your own systems.
Beyond standard sourcing flows, the Prokuria API also supports advanced no-code functionalities such as:
\nCustom Entities โ model your own data structures to fit unique business needs
\nWorkflows โ design and automate multi-step approval or validation processes
\nThese advanced features give you the flexibility to extend Prokuria beyond procurement into broader process automation.
\nAll requests require an access token.
Include it as a Bearer token in the Authorization header:
Authorization: Bearer {{vault:authToken}}
\nโ ๏ธ Replace {{vault:authToken}} with a valid token from your Prokuria account.
Use this as the prefix for all endpoints.
\nEvents โ Create and manage RFQs, RFPs, and auctions
\nSuppliers โ Invite and manage supplier participation
\nQuestions โ Configure questionnaires for events
\nDocuments โ Upload and download event-related files
\nLists & Settings โ Retrieve metadata such as question types or formatting rules
\nCustom Entities (coming soon) โ Extend Prokuria with domain-specific data
\nWorkflows (coming soon) โ Automate approvals and business processes
\nAll responses are in JSON.
\nTimestamps follow ISO-8601 format (UTC).
\nPagination is supported on list endpoints (skip and take parameters).
Explore the endpoints in the left navigation.
\nTry sample requests in Postman with your own token.
\nCheck the Examples tab on each endpoint for sample requests and responses.
\nThe Auth folder contains all endpoints related to authentication and authorisation in Prokuriaโs API. These methods allow client applications to securely obtain and refresh access tokens used across all other API calls.
\nWithin this section you will find endpoints that:
\nObtain an access token by providing valid user credentials or integration keys.
\nRefresh or validate an existing token when working with long-running sessions.
\n๐ All protected endpoints in the API require the Authorization: Bearer {{authToken}} header, obtained from this folder.
\n๐ The token service is exposed at /token and is separate from the main /api path.
\nUse these methods to ensure a secure session lifecycle for your integration, before accessing resources such as Events, Suppliers, Partners, or Workflows.
\n","_postman_id":"04e6b0a7-3e48-4cd2-8b12-a13bb859186f"},{"name":"Events","item":[{"name":"GetEvents","id":"f207829b-8ce9-445f-ab84-38c774735534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:authToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"skip\": {{skip}}, // number of records to skip (pagination offset)\r\n \"take\": {{take}}, // number of records to return (page size)\r\n \"sort\": {\r\n \"selector\": \"{{sortField}}\", // field name to sort by\r\n \"desc\": {{isDescending}} // true = descending, false = ascending\r\n },\r\n \"idEntityType\": {{entityTypeId}}, // numeric ID of the entity type (e.g. RFQ, Supplier)\r\n \"idViewType\": {{viewTypeId}}, // numeric ID of the view type (saved view or layout)\r\n \"isArchived\": {{isArchived}}, // true = include archived, false = active only\r\n \"columns\": {{columns}} // optional: list of column keys to include, or null for default\r\n}","options":{"raw":{"language":"json"}}},"url":"/entity/LoadEntityGridView1","description":"Retrieves a paginated list of events from Prokuria.
\nThis method supports pagination, sorting, filtering by archived status, and selecting which columns to return.
\nEndpoint:
\nPOST /api/entity/LoadEntityGridView1
\nHeaders:
\nBody Parameters
\n{\n \"skip\": {{skip}},\n \"take\": {{take}},\n \"sort\": {\n \"selector\": \"{{sortField}}\",\n \"desc\": {{isDescending}}\n },\n \"idEntityType\": {{entityTypeId}},\n \"idViewType\": {{viewTypeId}},\n \"isArchived\": {{isArchived}},\n \"columns\": {{columns}}\n}\n\n200 OK: Returns a JSON object containing the requested events.
\nThe response includes columns, dataSource, and other metadata.
\nThe GetEntityRecord method retrieves the full details of a single entity record based on its unique identifier and entity type.
\nUse this endpoint when you need the entire schema and configuration of a record, including metadata, sections, subgrids, UI layout, and permissions. This is typically used when opening or editing an entity in the Prokuria platform.
\n{\n \"id\": {{entityId}}, // The unique identifier of the record to retrieve\n \"idEntityType\": {{idEntityType}}, // The entity type identifier (same variable used in GetEvents; e.g. 20 for RFQ)\n \"isReadonly\": {{isReadonly}}, // Boolean flag (true/false) โ fetch record in read-only mode\n \"parentEntityName\": \"{{parentEntityName}}\" // Optional descriptive name of the parent entity (for reference only)\n}\n\nid โ required. The record ID to fetch.
\nidEntityType โ required. Identifies the entity type. Shared variable with GetEvents.
\nisReadonly โ optional. If true, the record is returned in a read-only state.
\nparentEntityName โ optional. Human-readable reference for context only.
\n{\n \"id\": 50001,\n \"idEntityType\": 20,\n \"isReadonly\": true,\n \"parentEntityName\": \"๐ RFQ โ Logistics & Transport Services Supply\"\n}\n\n{\n \"entityId\": 10001, // The parent entity type (e.g. Events)\n \"id\": 20001, // Internal record identifier\n \"schema\": [ // Form schema definition (sections, subgrids, layout, controls)\n {\n \"className\": \"section-label col-sm-12\",\n \"idSection\": 30001,\n \"type\": \"section\",\n \"sectionTemplate\": \"<h4>๐งฎ Evaluations</h4>\"\n },\n {\n \"className\": \"accordion-panel\",\n \"key\": \"subgrid_4001\",\n \"type\": \"subgrid\",\n \"idParentEntity\": 10001,\n \"idChildEntity\": 10002,\n \"idParentRecord\": 50001,\n \"isReadonly\": true,\n \"parentEntityName\": \"๐ RFQ โ Logistics & Transport Services Supply\",\n \"pageSize\": 25\n }\n ],\n \"name\": \"Untitled\", // Record name\n \"entityName\": \"Events\", // Entity type name\n \"breadcrumbs\": [ // Navigation breadcrumbs\n {\n \"name\": \"Events\",\n \"route\": \"https://app.prokuria.com/entity-list/10001\",\n \"isActive\": true\n },\n {\n \"name\": \"Untitled\",\n \"route\": \"https://app.prokuria.com/create-entity/50001\",\n \"isActive\": true\n }\n ],\n \"subgrids\": [ // Linked child entities\n {\n \"idParentEntity\": 10001,\n \"idParentRecord\": 50001,\n \"idChildEntity\": 10003\n },\n {\n \"idParentEntity\": 10001,\n \"idParentRecord\": 50001,\n \"idChildEntity\": 10002\n }\n ],\n \"canEdit\": true, // Permissions\n \"isArchived\": false // Record status\n}\n\nFetches all sections associated with a specific Request (e.g. RFP, RFQ, Event).
\nUse this endpoint to retrieve request item groups, question groups, or templates that make up the structure of the event, along with the invited suppliers.
\n// Path parameter:\n{{entityId}} // int; unique ID of the request/event\n// Headers:\nAuthorization: Bearer {{authToken}} // required\n\n๐ฅ Example Request
\ncurl --location '/events/sections/GetRequestSections/{{entityId}}' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --header 'Authorization: Bearer {{authToken}}'\n\n๐ค Example Response (anonymised)
\n{\n \"sections\": [\n {\n \"id\": 10001, // anonymised\n \"name\": \"General Transport Services\",\n \"sortOrder\": 1,\n \"idRequestItemGroup\": 20001, // anonymised\n \"idRequestQuestionGroup\": null,\n \"idRequestItemTemplate\": 30001, // anonymised\n \"specialMentions\": null,\n \"currency\": null,\n \"selectedInvites\": null,\n \"isSealed\": false,\n \"canEdit\": true\n },\n {\n \"id\": 10002,\n \"name\": \"Warehousing & Logistics Services\",\n \"sortOrder\": 2,\n \"idRequestItemGroup\": 20002,\n \"idRequestQuestionGroup\": null,\n \"idRequestItemTemplate\": 30002,\n \"specialMentions\": null,\n \"currency\": null,\n \"selectedInvites\": null,\n \"isSealed\": false,\n \"canEdit\": true\n },\n {\n \"id\": 10003,\n \"name\": \"Questionnaire โ Logistics & Compliance\",\n \"sortOrder\": 3,\n \"idRequestItemGroup\": null,\n \"idRequestQuestionGroup\": 20003,\n \"idRequestItemTemplate\": null,\n \"specialMentions\": null,\n \"currency\": null,\n \"selectedInvites\": null,\n \"isSealed\": false,\n \"canEdit\": true\n },\n {\n \"id\": 10004,\n \"name\": \"Service Quality & Warranty\",\n \"sortOrder\": 4,\n \"idRequestItemGroup\": null,\n \"idRequestQuestionGroup\": 20004,\n \"idRequestItemTemplate\": null,\n \"specialMentions\": null,\n \"currency\": null,\n \"selectedInvites\": null,\n \"isSealed\": false,\n \"canEdit\": true\n }\n ],\n \"invites\": [\n {\n \"key\": 40001, // anonymised\n \"value\": \"Demo Company Red\"\n },\n {\n \"key\": 40002,\n \"value\": \"๐๏ธ Demo Company Blue\"\n },\n {\n \"key\": 40003,\n \"value\": \"Demo Company Orange\"\n },\n {\n \"key\": 40004,\n \"value\": \"Demo Company Pink\"\n },\n {\n \"key\": 40005,\n \"value\": \"Demo Company Green\"\n }\n ]\n}\n\nThe sections array contains each logical block of the Request:
\nCan be an item group, questionnaire group, or template.
\nFields isSealed and canEdit indicate editability and visibility.
\nThe invites array lists all suppliers invited to participate.
\nentityId corresponds to the request ID from GetEvents.
\nRetrieves the userโs permissions for a specific event in Prokuria.
\nThe response shows available actions across event management, messaging, and supplier management.
\nGET /events/GetEventPermissions/{entityId}
\nGET /events/GetEventPermissions/{{entityId}}\nAuthorization: Bearer {{authToken}}\nAccept: application/json\n\nExample Response
\n{\n \"useProjects\": false, // Indicates if project features are enabled\n \"manageEvents\": {\n \"canEdit\": false, // User can edit event details\n \"viewOnly\": false, // User has view-only access\n \"noAccess\": false, // User has no access at all\n \"canApprove\": false // User can approve event changes\n },\n \"manageMessages\": {\n \"canEdit\": false, // User can edit event messages\n \"viewOnly\": false,\n \"noAccess\": false,\n \"canApprove\": false\n },\n \"manageSuppliers\": {\n \"canEdit\": false, // User can edit/manage suppliers\n \"viewOnly\": false,\n \"noAccess\": false,\n \"canApprove\": false\n }\n}\n\nNotes
\nEach management object (manageEvents, manageMessages, manageSuppliers) follows the same permission structure.
\nnoAccess, viewOnly, and canEdit are mutually exclusive access levels.
\ncanApprove applies when approvals are required.
\nuseProjects indicates whether project-related features are enabled.
\nDescription
\nRetrieves the list of Request Item Groups for a given event.
\nEach item in the response is a key/value pair representing the group ID and its display name.
\nRequest Body Parameters
\nN/A โ this is a GET request.
\nExample Request
\nGET /events/items/GetRequestItemGroups/{{entityId}}\nAuthorization: Bearer {{authToken}}\nAccept: application/json\n\nExample Response
\n[\n {\n \"key\": 10001, // Unique identifier of the request item group\n \"value\": \"General Transport Services\" // Display name of the group\n },\n {\n \"key\": 10002,\n \"value\": \"Warehousing & Logistics Services\"\n }\n]\n\nNotes
\nkey = internal identifier of the request item group.
\nvalue = human-readable name of the group.
\nUse these group IDs in subsequent calls (e.g. to fetch items/questions belonging to a group).
\nRetrieves all available field formats in Prokuria. These define how numeric, date, datetime, and currency values are displayed and stored. Useful for rendering UI fields, validating user input, or exporting data in a consistent format.
\nEndpoint
\nGET /entityDefinition/GetFieldFormats/\n\nRequest Headers
\nAuthorization (string, required): Bearer token ({{authToken}})
\nAccept: application/json
\nRequest Body Parameters
\nNone โ this is a simple GET call.
\nExample Request
\nGET /entityDefinition/GetFieldFormats/\nAuthorization: Bearer {{authToken}}\nAccept: application/json\n\nExample Response
\n[\n {\n \"id\": 4,\n \"fieldType\": 8, // Numeric\n \"format\": \"###0\",\n \"display\": \"1234\",\n \"sortOrder\": 1\n },\n {\n \"id\": 7,\n \"fieldType\": 8,\n \"format\": \"#,##0\",\n \"display\": \"1,234\",\n \"sortOrder\": 2\n },\n {\n \"id\": 9,\n \"fieldType\": 8,\n \"format\": \"#,##0.00\",\n \"display\": \"1,234.00\",\n \"sortOrder\": 4\n },\n {\n \"id\": 20,\n \"fieldType\": 7, // Date\n \"format\": \"dd/MM/yyyy\",\n \"display\": \"01/01/2022\",\n \"sortOrder\": 1\n },\n {\n \"id\": 25,\n \"fieldType\": 20, // DateTime\n \"format\": \"dd/MMM/yy HH:mm\",\n \"display\": \"01/Jan/2022 18:30\",\n \"sortOrder\": 1\n },\n {\n \"id\": 29,\n \"fieldType\": 8,\n \"format\": \"โฌ #,##0.00\",\n \"display\": \"โฌ 1,234.00\",\n \"sortOrder\": 15\n },\n {\n \"id\": 30,\n \"fieldType\": 8,\n \"format\": \"$ #,##0.00\",\n \"display\": \"$ 1,234.00\",\n \"sortOrder\": 16\n },\n {\n \"id\": 31,\n \"fieldType\": 8,\n \"format\": \"ยฃ #,##0.00\",\n \"display\": \"ยฃ 1,234.00\",\n \"sortOrder\": 17\n }\n // ... additional formats available\n]\n\nNotes
\nfieldType indicates the type of field:
\n7 = Date
\n8 = Number
\n20 = DateTime
\nformat follows Excel/Number format syntax (#,##0.00, %, currency prefixes).
\ndisplay shows a representative example of how values will appear in the UI.
\nUse sortOrder to control dropdown or selection ordering.
\nGreat โ hereโs a full documentation table mapping every format from your actual response. This will make it much easier to read in Postman Documenter or share with colleagues.
\nAll available field formats supported by Prokuria for Numbers, Dates, DateTimes, and Currencies.
\nNotes
\nField Types:
\n7 = Date
\n8 = Number
\n20 = DateTime
\nCurrencies Supported: Euro (โฌ), US Dollar ($), British Pound (ยฃ), South African Rand (R).
\nPercentages: Supported with 0, 2, or 4 decimal places.
\nUnits: Weight (kg) supported with 0 or 2 decimals.
\nRetrieves the list of available question types in Prokuria. Useful when building or configuring questionnaires, templates, or evaluation forms.
\nThe response acts as a dictionary of key โ value pairs.
\nRequest Body Parameters
\nNone โ this endpoint is a simple GET.
\nExample Request
\nGET /api/lists/QuestionTypes/ HTTP/1.1\nHost: api.prokuria.com\nAuthorization: Bearer {{authToken}}\nAccept: application/json\n\nExample Response
\n[\n {\n \"key\": 4,\n \"value\": \"Short text\"\n },\n {\n \"key\": 1,\n \"value\": \"Long text\"\n },\n {\n \"key\": 2,\n \"value\": \"Single Choice\"\n },\n {\n \"key\": 6,\n \"value\": \"Dropdown single choice\"\n },\n {\n \"key\": 3,\n \"value\": \"Multiple Choice\"\n },\n {\n \"key\": 7,\n \"value\": \"Dropdown multiple choice\"\n },\n {\n \"key\": 5,\n \"value\": \"File upload\"\n },\n {\n \"key\": 8,\n \"value\": \"Number\"\n },\n {\n \"key\": 9,\n \"value\": \"Date\"\n },\n {\n \"key\": 10,\n \"value\": \"Table\"\n }\n]\n\nLookup Table
\nNotes
\nKeys are system-defined constants and must be used as-is.
\nValues are human-readable labels shown in the UI.
\nTypically referenced when creating event sections, request items, or questionnaires.
\nRetrieves the system-defined columns for Event Questions.
\nUse this to render or validate the event questionnaire grid.
\nEndpoint
\nGET /events/questions/GetEventQuestionColumns/
\nHeaders
\n{\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vault:authToken}}\" // required\n}\n\nExample Response (shortened & annotated)
\n[\n {\n \"id\": 880687,\n \"dbColumnName\": \"title\",\n \"columnHeader\": \"EVENTS.QUESTIONS.NAME\",\n \"headerWidthPercent\": 30.0,\n \"sortOrder\": 2,\n \"isMandatory\": true,\n \"visible\": true,\n \"readOnly\": false,\n \"uploadDataType\": \"string\",\n \"fieldType\": 1, // Text input\n \"fieldTypeName\": \"api_custom_field_type_input\"\n },\n {\n \"id\": 880682,\n \"dbColumnName\": \"idQuestionType\",\n \"columnHeader\": \"EVENTS.QUESTIONS.TYPE\",\n \"headerWidthPercent\": 10.0,\n \"sortOrder\": 4,\n \"visible\": true,\n \"uploadDataType\": \"string\",\n \"fieldType\": null // Maps to /lists/QuestionTypes\n },\n {\n \"id\": 880685,\n \"dbColumnName\": \"scoring\",\n \"columnHeader\": \"EVENTS.QUESTIONS.SCORINT\",\n \"headerWidthPercent\": 15.0,\n \"sortOrder\": 6,\n \"visible\": true,\n \"dataType\": \"number\",\n \"uploadDataType\": \"decimal?\",\n \"format\": \"#,##0.00\",\n \"fieldType\": 8, // Number\n \"fieldTypeName\": \"api_custom_field_type_numeric\"\n },\n {\n \"id\": 880684,\n \"dbColumnName\": \"isMandatory\",\n \"columnHeader\": \"EVENTS.QUESTIONS.MANDATORY\",\n \"headerWidthPercent\": 6.0,\n \"sortOrder\": 7,\n \"visible\": true,\n \"dataType\": \"boolean\",\n \"uploadDataType\": \"boolean\",\n \"fieldType\": 3, // Checkbox (boolean)\n \"fieldTypeName\": \"api_custom_field_type_checkbox\"\n }\n]\n\nFieldType Mapping (inline reference)
\n1 โ Short text input
\n2 โ Single choice
\n3 โ Checkbox / Boolean
\n4 โ Long text
\n5 โ File upload
\n6 โ Dropdown single choice
\n7 โ Dropdown multiple choice
\n8 โ Number
\n9 โ Date
\n10 โ Table
\nNotes
\ndbColumnName = API/DB field name
\ncolumnHeader = i18n key for UI label
\nuploadDataType = expected type in imports (CSV/XLS)
\nformat = numeric/date formatting string (if applicable)
\nUse /lists/QuestionTypes to resolve idQuestionType values into human-readable labels
\nRetrieves all configured questions for a given event (eventId) and question (questionId).
\nThe response includes metadata, type, and options for each question.
\nPath Parameters
\neventId (path) โ ID of the event.
\nquestionId (path) โ ID of the specific question or question group.
\nExample Request
\nGET /events/questions/GetRequestQuestions/46128/10704\nAuthorization: Bearer {{vault:authToken}}\nAccept: application/json\n\nExample Response
\n[\n {\n \"id\": 183647,\n \"idRequest\": 46128, \n \"title\": \"What is your price per km for road transport services?\", \n \"isMandatory\": false, \n \"sortOrder\": 1,\n \"idQuestionType\": 4, // 4 = Short text\n \"questionTypeName\": \"Short text\",\n \"category\": \"Pricing\",\n \"options\": [] // no options for free-text\n },\n {\n \"id\": 183648,\n \"idRequest\": 46128, \n \"title\": \"Do you provide GPS tracking for all shipments?\", \n \"isMandatory\": false, \n \"sortOrder\": 2,\n \"idQuestionType\": 2, // 2 = Single choice\n \"questionTypeName\": \"Single Choice\",\n \"category\": \"Operations\",\n \"options\": [\n { \"id\": 635603, \"optionValue\": \"Yes\" },\n { \"id\": 635604, \"optionValue\": \"No\" }\n ]\n },\n {\n \"id\": 183649,\n \"idRequest\": 46128, \n \"title\": \"Upload ISO or ADR certifications\", \n \"sortOrder\": 3,\n \"idQuestionType\": 5, // 5 = File upload\n \"questionTypeName\": \"File upload\",\n \"category\": \"Compliance\",\n \"options\": []\n },\n {\n \"id\": 183650,\n \"idRequest\": 46128,\n \"title\": \"What is your standard lead time for deliveries?\", \n \"sortOrder\": 4,\n \"idQuestionType\": 4,\n \"questionTypeName\": \"Short text\",\n \"category\": \"Logistics\",\n \"options\": []\n },\n {\n \"id\": 183651,\n \"idRequest\": 46128,\n \"title\": \"Do you support urgent or same-day shipments?\", \n \"sortOrder\": 5,\n \"idQuestionType\": 4,\n \"questionTypeName\": \"Short text\",\n \"category\": \"Operations\",\n \"options\": []\n },\n {\n \"id\": 183652,\n \"idRequest\": 46128,\n \"title\": \"Can you operate in multiple regions across Romania?\", \n \"sortOrder\": 6,\n \"idQuestionType\": 2,\n \"questionTypeName\": \"Single Choice\",\n \"category\": \"Coverage\",\n \"options\": [\n { \"id\": 635605, \"optionValue\": \"Yes\" },\n { \"id\": 635606, \"optionValue\": \"No\" }\n ]\n }\n]\n\nNotes
\nidQuestionType links to /lists/QuestionTypes (dictionary of field types).
\nCommon types: 4 = Short text, 2 = Single Choice, 5 = File upload.
\noptions array is populated only for choice-type questions.
\nRetrieve detailed information about an event (e.g. RFQ, RFI, Tender). Includes metadata, status, templates, item groups, question groups, and breadcrumbs.
\nRequest Parameters
\nExample Request
\nGET /events/GetEvent/{{entityId}}\nAuthorization: Bearer {{vault:authToken}}\nAccept: application/json\n\nExample Response (shortened & annotated)
\n{\n \"id\": 46128, // Event ID\n \"name\": \"๐ RFQ โ Logistics & Transport Services Supply\",\n \"description\": \"<p>Dear Supplier...</p>\",\n \"idStatus\": 5,\n \"statusName\": \"r_status_biddingended\", // Bidding ended\n \"publicEventIdStr\": \"R46128\",\n \"breadcrumbs\": [\n { \"name\": \"๐Sourcing\", \"route\": \"https://app.prokuria.com/event-list\" },\n { \"name\": \"๐ RFQ โ Logistics...\", \"route\": \"https://app.prokuria.com/event/46128\" }\n ],\n \"itemTemplate\": {\n \"key\": 29726,\n \"value\": \"Default items template | ...\"\n },\n \"itemGroups\": [\n { \"id\": 10510, \"name\": \"General Transport Services\", \"idRequestItemTemplate\": 29727 },\n { \"id\": 10512, \"name\": \"Warehousing & Logistics Services\", \"idRequestItemTemplate\": 29730 }\n ],\n \"questionGroups\": [\n { \"key\": 10704, \"value\": \"Questionnaire โ Logistics & Compliance\" },\n { \"key\": 10705, \"value\": \"Service Quality & Warranty\" }\n ],\n \"owner\": { \"key\": 0, \"value\": null }, // No owner assigned\n \"isBidEnded\": true, // Event closed\n \"hasItems\": true,\n \"hasQuestions\": true,\n \"isArchived\": false\n}\n\nNotes
\ndescription contains HTML; sanitise before displaying externally.
\nitemGroups and questionGroups can be expanded with dedicated endpoints.
\nCombine with /events/GetEventPermissions/{{entityId}} to check user rights.
\nDear Supplier...
\",\n \"idStatus\": 5,\n \"statusName\": \"r_status_biddingended\", // Bidding ended\n \"publicEventIdStr\": \"R46128\",\n \"breadcrumbs\": [\n { \"name\": \"๐Sourcing\", \"route\": \"https://app.prokuria.com/event-list\" },\n { \"name\": \"๐ RFQ โ Logistics...\", \"route\": \"https://app.prokuria.com/event/46128\" }\n ],\n \"itemTemplate\": {\n \"key\": 29726,\n \"value\": \"Default items template | ...\"\n },\n \"itemGroups\": [\n { \"id\": 10510, \"name\": \"General Transport Services\", \"idRequestItemTemplate\": 29727 },\n { \"id\": 10512, \"name\": \"Warehousing & Logistics Services\", \"idRequestItemTemplate\": 29730 }\n ],\n \"questionGroups\": [\n { \"key\": 10704, \"value\": \"Questionnaire โ Logistics & Compliance\" },\n { \"key\": 10705, \"value\": \"Service Quality & Warranty\" }\n ],\n \"owner\": { \"key\": 0, \"value\": null }, // No owner assigned\n \"isBidEnded\": true, // Event closed\n \"hasItems\": true,\n \"hasQuestions\": true,\n \"isArchived\": false\n}"}],"_postman_id":"29a6efaf-f818-48f0-a967-e74cd7381263"},{"name":"GetGeneralInformation","id":"5c5cf0ef-5f0e-4c29-a278-2708eefe27aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:authToken}}"}],"url":"/events/GetGeneralInformation/{{entityId}}","description":"Retrieve general information about an event by its entityId.
\nRequest Body Parameters
\nNot applicable โ this is a GET request.
\nExample Request
\ncurl --location 'https://api.prokuria.com/api/events/GetGeneralInformation/12345' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer {{vault:authToken}}'\n\nExample Response
\n{\n \"id\": 12345, // Event ID\n \"requestType\": 0, // Numeric code for type (e.g., RFQ, RFI)\n \"entityType\": 0, // Internal entity type reference\n \"idCoreEntityType\": 0, // Core entity type reference\n \"name\": \"๐ RFQ โ Logistics & Transport Services Supply\", // Event name\n \"description\": \"<p class='preserveHtml' class='preserveHtml' class='preserveHtml'>Dear Supplier...</p>\", // Event description (HTML format)\n \"eventRoute\": null, // Workflow route name, if defined\n \"idStatus\": 0, // Internal status ID\n \"statusName\": null, // Status name (e.g., Draft, Active, Ended)\n \"publicEventIdStr\": null, // Public-facing event ID string\n \"security\": null, // Security/permissions object\n \"encQueryId\": null, // Encrypted query ID\n \"breadcrumbs\": null, // Navigation breadcrumbs\n \"subgrids\": null, // Child grids if applicable\n \"showPublicRequestInvites\": false, // Show public invites flag\n \"itemTemplates\": null, // Linked item templates\n \"itemTemplate\": { \"key\": 0, \"value\": null }, // Single item template\n \"isRfi\": false, // Is this an RFI\n \"isForm\": false, // Is this a form event\n \"isSupplierForm\": false, // Supplier form flag\n \"isDraft\": false, // Draft state\n \"isPrePublish\": false, // Pre-publish state\n \"isActive\": false, // Active state\n \"isStarted\": false, // Started flag\n \"isBidEnded\": false, // Bidding ended flag\n \"isCanceled\": false, // Canceled flag\n \"isAwarded\": false, // Awarded flag\n \"isPaused\": false, // Paused flag\n \"idParentEvent\": null, // Parent event ID if part of a series\n \"parentEventName\": null, // Parent event name\n \"itemGroups\": null, // Grouped items\n \"questionGroups\": null, // Question groups\n \"showMarkedToSuppliers\": false, // Marked-to-suppliers visibility\n \"exportButtons\": null, // Export config\n \"mentions\": null, // Mentions config\n \"updateCustomFields\": false, // Custom field updates allowed\n \"showDocuments\": false, // Document visibility\n \"showComments\": false, // Comment visibility\n \"idTeam\": [ 2001 ], // Team IDs associated\n \"teams\": [ // Teams assigned to the event\n { \"key\": 2001, \"value\": \"Demo Co.\" },\n { \"key\": 2002, \"value\": \"Requestor\" },\n { \"key\": 2003, \"value\": \"Approver\" },\n { \"key\": 2004, \"value\": \"Finance < 2000\" },\n { \"key\": 2005, \"value\": \"Finance > 2000\" },\n { \"key\": 2006, \"value\": \"CFO\" }\n ],\n \"idOwner\": 3001, // Owner ID\n \"owner\": { \"key\": 3001, \"value\": \"Jane Doe\" }, // Main owner\n \"owners\": [ // All owners assigned\n { \"key\": 3002, \"value\": \"Alex Smith\" },\n { \"key\": 3003, \"value\": \"Daniel Brown\" },\n { \"key\": 3004, \"value\": \"John Clark\" },\n { \"key\": 3001, \"value\": \"Jane Doe\" }\n ],\n \"allowPrebid\": false, // Pre-bid allowed\n \"priceAnalisysEnabled\": false, // Price analysis enabled\n \"openResponses\": 0, // Number of open responses\n \"showAuditLog\": false, // Audit log enabled\n \"hasItems\": false, // Items exist in event\n \"hasQuestions\": false, // Questions exist in event\n \"isArchived\": null, // Archive status\n \"ccEmail\": null // CC email address\n}\n\nโก Notes
\nUse this endpoint to fetch event metadata (title, description, status, teams, owners).
\nMost lifecycle booleans (isActive, isBidEnded) give a quick picture of the event state.
\ndescription is HTML โ may need rendering or sanitisation before display.
\nDear Supplier...
\", // Event description (HTML format)\n \"eventRoute\": null, // Workflow route name, if defined\n \"idStatus\": 0, // Internal status ID\n \"statusName\": null, // Status name (e.g., Draft, Active, Ended)\n \"publicEventIdStr\": null, // Public-facing event ID string\n \"security\": null, // Security/permissions object\n \"encQueryId\": null, // Encrypted query ID\n \"breadcrumbs\": null, // Navigation breadcrumbs\n \"subgrids\": null, // Child grids if applicable\n \"showPublicRequestInvites\": false, // Show public invites flag\n \"itemTemplates\": null, // Linked item templates\n \"itemTemplate\": { \"key\": 0, \"value\": null }, // Single item template\n \"isRfi\": false, // Is this an RFI\n \"isForm\": false, // Is this a form event\n \"isSupplierForm\": false, // Supplier form flag\n \"isDraft\": false, // Draft state\n \"isPrePublish\": false, // Pre-publish state\n \"isActive\": false, // Active state\n \"isStarted\": false, // Started flag\n \"isBidEnded\": false, // Bidding ended flag\n \"isCanceled\": false, // Canceled flag\n \"isAwarded\": false, // Awarded flag\n \"isPaused\": false, // Paused flag\n \"idParentEvent\": null, // Parent event ID if part of a series\n \"parentEventName\": null, // Parent event name\n \"itemGroups\": null, // Grouped items\n \"questionGroups\": null, // Question groups\n \"showMarkedToSuppliers\": false, // Marked-to-suppliers visibility\n \"exportButtons\": null, // Export config\n \"mentions\": null, // Mentions config\n \"updateCustomFields\": false, // Custom field updates allowed\n \"showDocuments\": false, // Document visibility\n \"showComments\": false, // Comment visibility\n \"idTeam\": [ 2001 ], // Team IDs associated\n \"teams\": [ // Teams assigned to the event\n { \"key\": 2001, \"value\": \"Demo Co.\" },\n { \"key\": 2002, \"value\": \"Requestor\" },\n { \"key\": 2003, \"value\": \"Approver\" },\n { \"key\": 2004, \"value\": \"Finance < 2000\" },\n { \"key\": 2005, \"value\": \"Finance > 2000\" },\n { \"key\": 2006, \"value\": \"CFO\" }\n ],\n \"idOwner\": 3001, // Owner ID\n \"owner\": { \"key\": 3001, \"value\": \"Jane Doe\" }, // Main owner\n \"owners\": [ // All owners assigned\n { \"key\": 3002, \"value\": \"Alex Smith\" },\n { \"key\": 3003, \"value\": \"Daniel Brown\" },\n { \"key\": 3004, \"value\": \"John Clark\" },\n { \"key\": 3001, \"value\": \"Jane Doe\" }\n ],\n \"allowPrebid\": false, // Pre-bid allowed\n \"priceAnalisysEnabled\": false, // Price analysis enabled\n \"openResponses\": 0, // Number of open responses\n \"showAuditLog\": false, // Audit log enabled\n \"hasItems\": false, // Items exist in event\n \"hasQuestions\": false, // Questions exist in event\n \"isArchived\": null, // Archive status\n \"ccEmail\": null // CC email address\n}"}],"_postman_id":"5c5cf0ef-5f0e-4c29-a278-2708eefe27aa"},{"name":"GetEventDocuments","id":"b3083d83-56e6-40aa-b4f2-c810a2b12873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:authToken}}"}],"url":"/globaldata/GetEventDocuments/{{entityId}}","description":"Description
\nRetrieve all documents attached to a specific event in Prokuria.
\nRequest Body Parameters
\nNone โ this is a GET request.
\nExample Request
\nGET /globaldata/GetEventDocuments/{{entityId}}\nAuthorization: Bearer {{vault:authToken}}\nAccept: application/json\n\nExample Response
\n[\n {\n \"id\": 0, // internal ID (may be 0 if not set)\n \"encId\": \"abc123xyz\", // encrypted identifier for document\n \"idEvent\": 0, // event ID (0 in placeholder data)\n \"idEventType\": 0, // event type (0 in placeholder data)\n \"fileName\": \"Company_Profile.pdf\", // uploaded file name\n \"fileData\": null, // raw file not included\n \"notes\": null, // optional notes field\n \"idCreatedBy\": 0, // user ID (0 if not available)\n \"createdBy\": null, // user name (null if not available)\n \"createdOn\": \"0001-01-01T00:00:00\" // upload timestamp (default if missing)\n },\n {\n \"id\": 0,\n \"encId\": \"def456uvw\",\n \"idEvent\": 0,\n \"idEventType\": 0,\n \"fileName\": \"Technical_Specs.docx\",\n \"fileData\": null,\n \"notes\": null,\n \"idCreatedBy\": 0,\n \"createdBy\": null,\n \"createdOn\": \"0001-01-01T00:00:00\"\n }\n]\n\nNotes
\nUse encId to uniquely identify the document for download/other operations.
\nidCreatedBy and createdBy may not always be populated.
\ncreatedOn defaults to 0001-01-01T00:00:00 if no real timestamp is available.
\nThe API does not return file contents directly (fileData is null).
\nDownload a specific document associated with an event. The document is identified by its encId, retrieved from GetEventDocuments. This endpoint returns the file as binary (PDF, DOCX, XLSX, etc.).
\nGET /globaldata/DownloadEventDocument/{{encId}}
\nAuthorization: Bearer {{vault:authToken}}
\nAccept: application/json
\ncurl --location 'https://api.prokuria.com/api/globaldata/DownloadEventDocument/vvagmjSa3kgEjJW2g' \\\n --header 'Authorization: Bearer {{vault:authToken}}' \\\n --header 'Accept: application/json'\n\n<binary file stream>\n\nIf the file is a PDF, the response will be PDF binary. For DOCX, the file stream will contain DOCX bytes. No JSON is returned.
\nUse GetEventDocuments first to list available files and obtain their encId.
\nThis method directly streams the file;
\nSupported file types depend on what was uploaded in the event (PDF, DOCX, XLSX, images, etc.).
\nDescription
\nReturns the list of questions configured for a given request (entityId) and section (sectionId). Use this to render supplier questionnaires, validate completion, or map question types to UI components.
\nPath Parameters
\nentityId (integer) โ Request/Event ID.
\nsectionId (integer) โ Section (question group) ID.
\nAuth
\nRelated lookups
\n[\n {\n \"id\": 179496, // Unique question ID\n \"idRequest\": 45320, // Parent request (entity) ID\n \"title\": \"What is your delivery cost per KM?\", // Question text (buyer-facing)\n \"description\": \"\\n\", // Optional helper/desc (may contain HTML/newlines)\n \"isMandatory\": false, // If suppliers must answer\n \"canUploadFiles\": true, // Allow attachments alongside the answer\n \"sortOrder\": 1, // Display order within the section\n \"idQuestionType\": 4, // Type code (see /lists/QuestionTypes)\n \"questionTypeName\": \"Short text\", // Human-readable type\n \"options\": [], // Options (for choice types); empty for text/file\n \"optionValueName\": null, // Option label aggregation (rarely used)\n \"category\": \" Logistics\", // Optional categorisation label\n \"questionType\": { \"key\": 0, \"value\": null }, // Legacy/aux mapping (usually not needed)\n \"conditionedQuestion\": false, // If the question is conditionally shown\n \"idRequestConditionedQuestion\": null, // Controller question ID (when conditioned)\n \"idRequestConditionedQuestionOption\": null,// Controller option ID (when conditioned)\n \"conditionedShowHide\": { \"key\": 0, \"value\": null }, // Show/Hide rule (enum-like)\n \"showHide\": null, // Deprecated/alternate conditional slot\n \"beforeStatement\": null, // Static text shown before the question\n \"afterStatement\": null, // Static text shown after the question\n \"hasStatement\": false, // Whether before/after statements exist\n \"idRequestQuestionGroup\": null, // Owning group (if nested groups are used)\n \"scoring\": null, // Per-question scoring config (if evaluation)\n \"hasResponses\": true, // Indicates suppliers have responded\n \"format\": null, // Formatting mask (e.g., numbers/dates)\n \"dataStructure\": \"{\\\"Workbook\\\":{...}} // Stringified spreadsheet config (used by table-like inputs or rich editors)\n },\n {\n \"id\": 179497,\n \"idRequest\": 45320,\n \"title\": \"Do you provide AOG (Aircraft on Ground) delivery support?\",\n \"description\": null,\n \"isMandatory\": true,\n \"canUploadFiles\": true, // File evidence allowed with the answer\n \"sortOrder\": 2,\n \"idQuestionType\": 2, // 2 = Single Choice\n \"questionTypeName\": \"Single Choice\",\n \"options\": [ // Choice options to render as radio buttons\n {\n \"id\": 613481,\n \"optionValue\": \"No\",\n \"checkedId\": null, \"textValue\": null,\n \"idDuplicate\": null, \"sortOrder\": null,\n \"checked\": null, \"scoring\": null\n },\n {\n \"id\": 613483,\n \"optionValue\": \"Yes\",\n \"checkedId\": null, \"textValue\": null,\n \"idDuplicate\": null, \"sortOrder\": null,\n \"checked\": null, \"scoring\": null\n }\n ],\n \"optionValueName\": null,\n \"category\": \" Logistics\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179498,\n \"idRequest\": 45320,\n \"title\": \"Upload your quality system certification (e.g. ISO 9001, AS9100)\",\n \"description\": \"\",\n \"isMandatory\": false,\n \"canUploadFiles\": true, // File upload question type supports attachments only\n \"sortOrder\": 3,\n \"idQuestionType\": 5, // 5 = File upload\n \"questionTypeName\": \"File upload\",\n \"options\": [],\n \"optionValueName\": null,\n \"category\": \"Compliance\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179890,\n \"idRequest\": 45320,\n \"title\": \"Are you an OEM, authorized distributor, or independent supplier?\",\n \"description\": null,\n \"isMandatory\": true,\n \"canUploadFiles\": false,\n \"sortOrder\": 4,\n \"idQuestionType\": 2, // Single Choice\n \"questionTypeName\": \"Single Choice\",\n \"options\": [\n { \"id\": 615937, \"optionValue\": \"Yes\", \"checkedId\": null, \"textValue\": null, \"idDuplicate\": null, \"sortOrder\": null, \"checked\": null, \"scoring\": null },\n { \"id\": 615938, \"optionValue\": \"No\", \"checkedId\": null, \"textValue\": null, \"idDuplicate\": null, \"sortOrder\": null, \"checked\": null, \"scoring\": null }\n ],\n \"optionValueName\": null,\n \"category\": \"Compliance\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179891,\n \"idRequest\": 45320,\n \"title\": \"Do your products include FAA 8130-3 / EASA Form 1 certificates?\",\n \"description\": null,\n \"isMandatory\": true,\n \"canUploadFiles\": false,\n \"sortOrder\": 5,\n \"idQuestionType\": 2,\n \"questionTypeName\": \"Single Choice\",\n \"options\": [\n { \"id\": 615939, \"optionValue\": \"Yes\", \"checkedId\": null, \"textValue\": null, \"idDuplicate\": null, \"sortOrder\": null, \"checked\": null, \"scoring\": null },\n { \"id\": 615940, \"optionValue\": \"No\", \"checkedId\": null, \"textValue\": null, \"idDuplicate\": null, \"sortOrder\": null, \"checked\": null, \"scoring\": null }\n ],\n \"optionValueName\": null,\n \"category\": \"Compliance\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179892,\n \"idRequest\": 45320,\n \"title\": \"How do you ensure traceability for all shipped items?\\n\\n\",\n \"description\": null,\n \"isMandatory\": false,\n \"canUploadFiles\": false,\n \"sortOrder\": 6,\n \"idQuestionType\": 4, // Short text\n \"questionTypeName\": \"Short text\",\n \"options\": [],\n \"optionValueName\": null,\n \"category\": \"Compliance\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179893,\n \"idRequest\": 45320,\n \"title\": \"If hazardous materials are involved, how are they packaged/labeled?\",\n \"description\": null,\n \"isMandatory\": false,\n \"canUploadFiles\": false,\n \"sortOrder\": 7,\n \"idQuestionType\": 4,\n \"questionTypeName\": \"Short text\",\n \"options\": [],\n \"optionValueName\": null,\n \"category\": \"Logistics\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n },\n {\n \"id\": 179894,\n \"idRequest\": 45320,\n \"title\": \"Provide estimated lead time per product group.\",\n \"description\": null,\n \"isMandatory\": false,\n \"canUploadFiles\": false,\n \"sortOrder\": 8,\n \"idQuestionType\": 4,\n \"questionTypeName\": \"Short text\",\n \"options\": [],\n \"optionValueName\": null,\n \"category\": \"Logistics\",\n \"questionType\": { \"key\": 0, \"value\": null },\n \"conditionedQuestion\": false,\n \"idRequestConditionedQuestion\": null,\n \"idRequestConditionedQuestionOption\": null,\n \"conditionedShowHide\": { \"key\": 0, \"value\": null },\n \"showHide\": null,\n \"beforeStatement\": null,\n \"afterStatement\": null,\n \"hasStatement\": false,\n \"idRequestQuestionGroup\": null,\n \"scoring\": null,\n \"hasResponses\": true,\n \"format\": null,\n \"dataStructure\": null\n }\n]\n\nThe Events folder contains all endpoints related to creating, managing, and retrieving procurement events in Prokuria. Events represent structured sourcing activities such as RFQs, RFPs, eAuctions, or questionnaires, and are a central building block of the platform.
\nWithin this section you will find endpoints that allow you to:
\nRetrieve event details (by id or encoded identifier).
\nList events for a buyer organisation or supplier, including filtering by type and status.
\nAccess event content such as product/item structures, questionnaires, and supplier-facing views.
\nDownload event documents uploaded either by the buyer (attachments, specs) or suppliers (responses, clarifications).
\nManage event participation, including suppliers invited, responses submitted, and evaluation data.
\nCheck event status and workflow progression (draft, published, bidding open, bidding ended, etc.).
\n๐ Many of these methods rely on the idEntityType parameter to determine context (e.g. 21 for suppliers, 20 for buyer events).
\n๐ Event endpoints often return rich, structured JSON including metadata (status, routes, security permissions) and nested entities (items, questions, documents).
\nThis folder provides the full lifecycle coverage of Prokuria events โ from creation and supplier invitation to document retrieval and closing โ ensuring seamless integration of sourcing workflows with your own systems.
\n","event":[{"listen":"prerequest","script":{"id":"27a8ef1a-0fdb-4038-961b-761564f1e5cb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"597e8ba2-3566-4843-b93e-cdfcaa681364","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"3e9960e8-9402-4e16-a93e-dbb68f8c9178"},{"name":"Suppliers","item":[{"name":"getSuppliers","id":"c65da81d-d67e-4972-b465-dd61c291a178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:authToken}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"skip\": {{skip}},\n \"take\": {{take}},\n \"sort\": {\n \"selector\": \"{{sortSelector}}\",\n \"desc\": {{isDesc}}\n },\n \"idEntityType\": {{idEntityType}},\n \"idViewType\": {{idViewType}},\n \"isArchived\": {{isArchived}},\n \"columns\": null\n}","options":{"raw":{"language":"json"}}},"url":"/entity/LoadEntityGridView1","description":"Retrieves a paginated and sortable list of suppliers for a given grid view. This endpoint supports sorting, filtering, and pagination.
\nidEntityType = 21 โ Suppliers
\nOther values of idEntityType may represent different entity types (e.g. custom entities, requests).
\nRequest Body Parameters
\n{\n \"skip\": 0, // integer, start index for pagination\n \"take\": 50, // integer, number of rows to fetch\n \"sort\": {\n \"selector\": \"name\", // string, column name to sort by\n \"desc\": false // boolean, sort order (true = descending)\n },\n \"idEntityType\": 21, // integer, entity type identifier (21 = suppliers)\n \"idViewType\": 98308, // integer, grid view identifier for suppliers\n \"isArchived\": false, // boolean, include archived records\n \"columns\": null // array of column definitions (optional)\n}\n\nExample Request
\ncurl --location 'https://api.prokuria.com/api/entity/LoadEntityGridView1' \\\n--header 'Authorization: Bearer {{vault:authToken}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n \"skip\": 0,\n \"take\": 50,\n \"sort\": { \"selector\": \"name\", \"desc\": false },\n \"idEntityType\": 21,\n \"idViewType\": 98308,\n \"isArchived\": false,\n \"columns\": null\n}'\n\nExample Response
\n{\n \"columns\": [],\n \"dataSource\": [\n {\n \"id\": 90001, // unique supplier ID\n \"name\": \"๐ Company Alpha\", // supplier name\n \"idPartnerCompanyStatus\": 2, // status code (1=Draft, 2=Active, 3=Inactive)\n \"idPartnerCompanyStatus_Value\": \"Active\", \n \"idOwner\": 91001, // account manager ID\n \"idOwner_Value\": \"Owner A\", // account manager name\n \"idMainContact\": 92001, // main contact ID\n \"idMainContact_Value\": \"Contact A\", // main contact name\n \"partn_risk\": 2, // risk score (1=Green, 2=Yellow, 3=Red)\n \"partn_risk_Value\": \"๐ก Yellow\", \n \"partn_segment\": 2, // supplier segmentation\n \"partn_segment_Value\": \"Tier 2๏ธโฃ\", \n \"partn_lthreecategory\": 99001, \n \"partn_lthreecategory_Value\": \"L3 Category A\", \n \"partn_country\": 99501, \n \"partn_country_Value\": \"United States Of America\", \n \"canEdit\": true, \n \"isArchived\": false \n },\n {\n \"id\": 90002,\n \"name\": \"๐ป Company Delta\",\n \"idPartnerCompanyStatus\": 2,\n \"idPartnerCompanyStatus_Value\": \"Active\",\n \"idOwner\": 91002,\n \"idOwner_Value\": \"Owner B\",\n \"idMainContact\": 92002,\n \"idMainContact_Value\": \"Contact B\",\n \"partn_risk\": 1,\n \"partn_risk_Value\": \"๐ข Green\",\n \"partn_segment\": 3,\n \"partn_segment_Value\": \"Tier 3๏ธโฃ\",\n \"partn_lthreecategory\": 99003,\n \"partn_lthreecategory_Value\": \"L3 Category C\",\n \"partn_country\": 99501,\n \"partn_country_Value\": \"United States Of America\",\n \"canEdit\": true,\n \"isArchived\": false\n }\n ],\n \"state\": \"{...}\", // grid view state (columns, filters, paging, etc.)\n \"totalCount\": 2, // number of suppliers returned in this page\n \"summary\": \"\" // summary section (empty in this case)\n}\n\nNotes
\nidEntityType = 21 โ suppliers list.
\nidViewType controls which grid view (saved filters/columns) is applied.
\nUse skip + take for pagination.
\nStatus (idPartnerCompanyStatus / _Value) โ Draft / Active / Inactive
\nRisk (partn_risk) โ Green / Yellow / Red
\nSegment (partn_segment) โ Tier 1 / Tier 2 / Tier 3
\nCategory (partn_lthreecategory) โ internal categorisation
\nCountry (partn_country)
\nRetrieve a custom entity record.
\nThe idEntityType determines which type of entity is returned โ for example, 21 corresponds to a Supplier. The response includes the full schema (sections, fields, subgrids) plus UI flags (documents, comments, edit rights, etc.).
\n{\n \"id\": 45817, // int, required: entity record ID\n \"idEntityType\": 21, // int, required: entity type (21 = Supplier)\n \"isReadonly\": false, // bool, optional: true = disable editing\n \"parentEntityName\": \"Office Furniture Supplier\" // string, optional: label for subgrids\n}\n\ncurl --location 'https://api.prokuria.com/api/entity/GetEntityRecord/' \\\n --header 'Authorization: Bearer {{vault:authToken}}' \\\n --header 'Content-Type: application/json' \\\n --header 'Accept: application/json' \\\n --data '{\n \"id\": 45817,\n \"idEntityType\": 21,\n \"isReadonly\": false,\n \"parentEntityName\": \"Office Furniture Supplier\"\n }'\n\n{\n \"entityId\": 90001, // entity type ID (21 = Supplier, anonymised here)\n \"id\": 1234567, // record ID\n \"entityName\": \"Suppliers\", // display name of entity\n \"idParentSystemRecord\": 45817,// parent record linkage (e.g., company)\n \"schema\": [\n { \"type\": \"section\",\"idSection\": 20002,\"className\": \"section-label col-sm-12\",\"backgroundColor\": \"#d9eaff\",\"isExpandable\": true,\"sectionTemplate\": \"<h4>๐ท๏ธ Supplier Segmentation</h4>\" },\n { \"className\": \"accordion-panel\",\"fieldGroup\": [\n { \"key\": \"partn_segment\",\"type\": \"ng-select\",\"templateOptions\": { \"label\": \"Segment\",\"options\": [\n { \"label\": \"Tier 1๏ธโฃ\",\"value\": 1 },{ \"label\": \"Tier 2๏ธโฃ\",\"value\": 2 },{ \"label\": \"Tier 3๏ธโฃ\",\"value\": 3 }\n ]},\"defaultValue\": 1 },\n { \"key\": \"partn_risk\",\"type\": \"ng-select\",\"templateOptions\": { \"label\": \"Risk\",\"options\": [\n { \"label\": \"๐ข Green\",\"value\": 1 },{ \"label\": \"๐ก Yellow\",\"value\": 2 },{ \"label\": \"๐ด Red\",\"value\": 3 }\n ]},\"defaultValue\": 2 }\n ]},\n { \"type\": \"section\",\"idSection\": 20003,\"className\": \"section-label col-sm-12\",\"backgroundColor\": \"#d9eaff\",\"isExpandable\": true,\"sectionTemplate\": \"<h4>๐ฆ Banking Information</h4>\" },\n { \"className\": \"accordion-panel\",\"fieldGroup\": [\n { \"key\": \"partn_officialcompanyname\",\"type\": \"textbox\",\"templateOptions\": { \"label\": \"Official Company Name\" },\"defaultValue\": \"Demo Supplier Ltd.\" },\n { \"key\": \"partn_country\",\"type\": \"ng-select\",\"templateOptions\": { \"label\": \"Country\",\"options\": [\n { \"label\": \"France\",\"value\": 1153617 },{ \"label\": \"Germany\",\"value\": 1153621 },{ \"label\": \"United States\",\"value\": 1153743 }\n // ... truncated\n ]},\"defaultValue\": 1153617 },\n { \"key\": \"iban\",\"type\": \"textbox\",\"templateOptions\": { \"label\": \"IBAN\" },\"defaultValue\": null }\n ]},\n { \"type\": \"section\",\"idSection\": 20100,\"className\": \"section-label col-sm-12\",\"backgroundColor\": \"#fff5e8\",\"isExpandable\": true,\"sectionTemplate\": \"<h4>๐ Certifications</h4>\" },\n { \"type\": \"subgrid\",\"key\": \"subgrid_certifications\",\"idParentEntity\": 90001,\"idChildEntity\": 98652,\"idParentRecord\": 45817,\"openInModal\": true,\"showAddButton\": true,\"showEditButton\": true,\"showDeleteButton\": true,\"pageSize\": 25 }\n ],\n \"showDocuments\": true, // documents tab visible\n \"showComments\": true, // comments tab visible\n \"canEdit\": true, // current user can edit\n \"isArchived\": false,\n \"breadcrumbs\": [\n { \"name\": \"Suppliers\",\"route\": \"https://app.prokuria.com/entity-list/90001\",\"isActive\": true },\n { \"name\": \"\",\"route\": \"https://app.prokuria.com/create-entity/45817\",\"isActive\": true }\n ]\n}\n\nidEntityType determines which schema is returned. Example: 21 = Supplier.
\nschema[] drives the UI: sections, fields (textbox, ng-select, subgrid).
\nLong lists (countries, user pickers) truncated in this example.
\nUse isReadonly: true to preview layout safely without enabling edits.
\nFlags (showDocuments, showComments, canEdit) toggle available features.
\nRelated records are provided via subgrid entries.
\nGet details for a supplier company by its ID. Returns profile data, ownership, contacts, team options, breadcrumbs, permissions, and supported currencies.
\nGET /ManagePartners/GetCompany/{entityId}
\n{\n \"id\": 45001, // Supplier company ID\n \"encId\": null,\n \"suIdStr\": null,\n \"name\": \"Office Furniture Supplier\", // Display name\n \"taxId\": null,\n \"address\": null,\n \"notes\": null,\n \"phone\": null,\n \"fax\": null,\n \"emails\": null,\n \"website\": null,\n \"group\": null,\n \"key\": null,\n \"idCountry\": null,\n \"idPartnerCompanyRisk\": null, // Risk code, if set\n \"idPartnerCompanySegment\": null, // Segment code, if set\n \"idOwner\": 10001, // Internal owner ID\n \"idOwnerEncrypted\": null,\n \"ownerName\": \"Alex Example | Tech Account Manager | alex.example+xyz@prokuria.test\",\n \"idCreatedBy\": null,\n \"createdBy\": null,\n \"createdOn\": \"2025-08-27T08:57:53\",\n \"createdByUser\": { \"key\": 10001, \"value\": \"Alex Example | Tech Account Manager\" },\n \"idTeam\": [],\n \"score\": null,\n \"idPartnerCompanyStatus\": null,\n \"idStatus\": 1, // Internal status code\n \"country\": null,\n \"partners\": [ // Linked contacts\n {\n \"id\": 48001,\n \"idPartnerCompany\": null,\n \"partnerCompany\": null,\n \"email\": \"supplier.contact+demo@example.test\",\n \"name\": \"John Example\",\n \"position\": null,\n \"phone\": null,\n \"notes\": null,\n \"toAssign\": false,\n \"unsubscribed\": false,\n \"unsubscribedDate\": null,\n \"idPartnerStatus\": 0,\n \"partnerStatus\": null,\n \"actionDate\": null,\n \"idLanguage\": null,\n \"language\": null,\n \"encQueryId\": null,\n \"isArchived\": false,\n \"categories\": null,\n \"risk\": null,\n \"segment\": null,\n \"idCreatedBy\": null,\n \"createdBy\": null,\n \"createdOn\": null,\n \"idOwner\": null,\n \"owner\": null,\n \"idTeam\": null,\n \"breadcrumbs\": null,\n \"subgrids\": null,\n \"updateCustomFields\": false,\n \"showComments\": false,\n \"commentsNonEditable\": false,\n \"showDocuments\": false,\n \"showAuditLog\": false,\n \"idPartnerType\": null,\n \"idOperationalUnit\": null,\n \"canEdit\": false,\n \"idModifiedBy\": null,\n \"modifiedOn\": null,\n \"idSendGridMailLastStatus\": null,\n \"sendGridMailLastDate\": null\n }\n ],\n \"documents\": [],\n \"categories\": [],\n \"supplierCategories\": null,\n \"encQueryId\": \"A1bCxyZ9qT7vR2LpQmN8s\", // Anonymised token\n \"isArchived\": false,\n \"statusName\": \"Draft\",\n \"tags\": null,\n \"selectedTags\": [],\n \"tagsSource\": [],\n \"breadcrumbs\": [\n { \"name\": \"๐ Suppliers\", \"route\": \"https://app.prokuria.com/company-supplier-list/\", \"isActive\": true },\n { \"name\": \"Office Furniture Supplier\", \"route\": \"https://app.prokuria.com/create-company-supplier/45001\", \"isActive\": false }\n ],\n \"subgrids\": null,\n \"selectedTeam\": null,\n \"team\": { \"key\": 0, \"value\": null },\n \"teams\": [\n { \"key\": 2501, \"value\": \"XYZ Company\" },\n { \"key\": 2502, \"value\": \"Purchasing\" },\n { \"key\": 2503, \"value\": \"Approval\" },\n { \"key\": 3044, \"value\": \"France Team\" },\n { \"key\": 3045, \"value\": \"United Kingdom Team\" }\n ],\n \"modifiedBy\": { \"key\": 10001, \"value\": \"Alex Example | Tech Account Manager\" },\n \"modifiedOn\": \"2025-08-27T09:11:40\",\n \"canDelete\": false,\n \"updateCustomFields\": true, // UI can render custom fields\n \"idMainContact\": 48001, // Should match one of partners[].id\n \"mainContact\": { \"key\": 48001, \"value\": \"John Example\" },\n \"idPreferredCurrency\": null, // If set, matches a currencies[].key\n \"currencies\": [\n { \"key\": 1, \"value\": \"RON\" },\n { \"key\": 1002, \"value\": \"EUR\" },\n { \"key\": 1003, \"value\": \"USD\" },\n { \"key\": 1004, \"value\": \"GBP\" }\n /* โฆtruncated for brevity */\n ],\n \"companyName\": null,\n \"companyPhoto\": null,\n \"encIdEntityType\": null,\n \"idLanguage\": null,\n \"encIdPartner\": null,\n \"fullPartnerName\": null,\n \"canUseSupplierPortal\": true,\n \"showDocuments\": true,\n \"showComments\": true,\n \"commentsNonEditable\": false,\n \"canUseEvents\": false,\n \"showAuditLog\": false,\n \"canEdit\": true,\n \"accessBlocked\": false\n}\n\nidMainContact must reference one of the entries in partners[].
\nidPreferredCurrency (when present) should equal a currencies[].key.
\nbreadcrumbs[].route are UI links; not required for API usage.
\nUpdates the details of an existing supplier in Prokuria.
\nThis method allows you to modify supplier information such as name, country, main contact, categories, status, segment, risk, owner, teams, and access control.
\nโ ๏ธ Important: All parameters are mandatory, except for categoryName, which is optional and included for readability only.
\nโ On success, the endpoint returns HTTP 200 OK with no response body.
\n{\n \"id\": {{supplierId}}, // (required) Supplier ID\n \"name\": \"{{supplierName}}\", // (required) Supplier name\n \"idCountry\": {{idCountry}}, // (required) Country ID\n \"idMainContact\": {{idMainContact}}, // (required) Main contact ID\n \"categories\": [ // (required) At least one category\n {\n \"id\": {{categoryLinkId}}, // (required) Internal mapping ID\n \"idCategory\": {{idCategory}}, // (required) Category ID\n \"name\": \"{{categoryName}}\" // (optional) Human-readable category name\n }\n ],\n \"idStatus\": {{idStatus}}, // (required) Supplier status ID\n \"idPartnerCompanySegment\": {{idSegment}}, // (required) Segment ID\n \"idPartnerCompanyRisk\": {{idRisk}}, // (required) Risk ID\n \"idOwner\": {{idOwner}}, // (required) Supplier owner ID\n \"idTeam\": [{{idTeam}}], // (required) Array with at least one team ID\n \"accessBlocked\": {{isBlocked}} // (required) true = block supplier access\n}\n\nPOST /ManagePartners/UpdateCompanySummary/\nAuthorization: Bearer {{vault:authToken}}\nContent-Type: application/json\n\nBody:
\n{\n \"id\": 29001,\n \"name\": \"โญ Supplier 3 Green Co.\",\n \"idCountry\": 198,\n \"idMainContact\": 26001,\n \"categories\": [\n {\n \"id\": 42001,\n \"idCategory\": 4801,\n \"name\": \"Furniture\"\n }\n ],\n \"idStatus\": 2,\n \"idPartnerCompanySegment\": 5001,\n \"idPartnerCompanyRisk\": 5002,\n \"idOwner\": 10001,\n \"idTeam\": [3001],\n \"accessBlocked\": false\n}\n\nHTTP/1.1 200 OK\n\n(No response body returned)
\ncategoryName is optional; it is not validated by the system but recommended for readability.
\nAll numeric IDs (supplierId, idCountry, idMainContact, idCategory, idOwner, etc.) must be retrieved from prior API calls (suppliers list, contacts, categories, users, teams).
\nAt least one category is required in the categories array.
\naccessBlocked defaults to false; set to true to block supplierโs access.
\nThe Suppliers folder contains all endpoints related to managing supplier companies and their associated data within Prokuria. Suppliers are a core entity in the platform and can be created, updated, categorised, and linked to events.
\nWithin this section you will find endpoints that allow you to:
\nRetrieve supplier details (by entityId and idEntityType = 21).
\nList suppliers with filtering by status, category, risk, or segment.
\nUpdate supplier information such as company summary, contact details, and classifications.
\nAccess linked data including owners, main contacts, and categorisation (risk level, segment, L3 category, country).
\nManage documents and attachments connected to suppliers.
\n๐ Most endpoints require both entityId (the supplierโs unique identifier) and idEntityType = 21 to indicate that the request targets a supplier entity.
\n๐ Update methods typically return only a 200 OK status on success without a response body.
\n๐ Supplier list and detail endpoints return structured JSON with metadata, owner info, categorisations, and status values.
\nThis folder covers the full supplier management lifecycle โ from onboarding and classification to maintenance and integration into sourcing workflows.
\n","_postman_id":"94cf7f65-f3cd-49c3-bbdd-2e1eb84992da"},{"name":"Contacts","item":[{"name":"GetContacts","id":"f5ff3bd3-b94a-420a-9f98-4703a1cfdd3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:authToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"skip\": {{skip}},\n \"take\": {{take}},\n \"idEntityType\": {{idEntityType}}, // 22 = Contacts\n \"idViewType\": {{idViewType}},\n \"isArchived\": {{isArchived}},\n \"columns\": null\n }","options":{"raw":{"language":"json"}}},"url":"/entity/LoadEntityGridView1","description":"Purpose: Retrieve a paginated list of Contacts for a given view (grid) in Prokuria.
\nEntity type: idEntityType = 22 (Contacts).
\nTypical use: Populate Contacts tables with sorting/filtering defined by a saved view (idViewType).
\nPOST /entity/LoadEntityGridView1
\nAuth: Bearer {{vault:authToken}}
\nContent-Type: application/json
\n{\n \"skip\": {{skip}}, // int - offset for pagination (e.g., 0, 50, 100)\n \"take\": {{take}}, // int - page size (e.g., 50)\n \"idEntityType\": {{idEntityType}}, // int - 22 = Contacts\n \"idViewType\": {{idViewType}}, // int - the saved view ID defining columns/filters/sort\n \"isArchived\": {{isArchived}}, // bool - include archived items (false by default)\n \"columns\": null // null or array - when null, server uses viewโs default columns\n}\n\n{{vault:authToken}} โ (managed in Vault)
\n{{skip}} โ 0
\n{{take}} โ 50
\n{{idEntityType}} โ 22
\n{{idViewType}} โ 98712
\n{{isArchived}} โ false
\ncurl -X POST '/entity/LoadEntityGridView1' \\\n -H 'Accept: application/json' \\\n -H 'Authorization: Bearer {{vault:authToken}}' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"skip\": {{skip}},\n \"take\": {{take}},\n \"idEntityType\": {{idEntityType}},\n \"idViewType\": {{idViewType}},\n \"isArchived\": {{isArchived}},\n \"columns\": null\n }'\n\nExample Response (anonymised & shortened)
\n{\n \"columns\": [],\n \"dataSource\": [\n {\n \"id\": 48001, // Contact ID\n \"idCompany\": 45001, // Linked company ID\n \"idCompany_Value\": \"Supplier A Ltd\", // Company name\n \"name\": \"John Smith\", // Contact name\n \"position\": null,\n \"email\": \"john.smith@example.com\",\n \"phone\": null,\n \"idLanguage\": 2,\n \"idLanguage_Value\": \"English\",\n \"idPartnerStatus\": 1,\n \"idPartnerStatus_Value\": \"Active\",\n \"canEdit\": true,\n \"isArchived\": false\n },\n {\n \"id\": 48002,\n \"idCompany\": 45002,\n \"idCompany_Value\": \"Supplier B SRL\",\n \"name\": \"Jane Doe\",\n \"position\": \"Manager\",\n \"email\": \"jane.doe@example.com\",\n \"phone\": \"+40123456789\",\n \"idLanguage\": 2,\n \"idLanguage_Value\": \"English\",\n \"idPartnerStatus\": 1,\n \"idPartnerStatus_Value\": \"Active\",\n \"canEdit\": true,\n \"isArchived\": false\n },\n {\n \"id\": 48003,\n \"idCompany\": 45003,\n \"idCompany_Value\": \"Demo Company Blue\",\n \"name\": \"Alex Green\",\n \"position\": null,\n \"email\": \"alex.green@example.com\",\n \"phone\": null,\n \"idLanguage\": 2,\n \"idLanguage_Value\": \"English\",\n \"idPartnerStatus\": 2,\n \"idPartnerStatus_Value\": \"Inactive\",\n \"canEdit\": true,\n \"isArchived\": false\n }\n ],\n \"state\": null,\n \"totalCount\": 3,\n \"summary\": \"\"\n}\n\ncolumns: empty array or server-provided column metadata (depends on view).
\ndataSource: list of Contacts.
\nid: Contact identifier.
\nidCompany / idCompany_Value: linked company reference & display name.
\nname, position, email, phone: basic contact details.
\nidLanguage / idLanguage_Value: numeric code & readable label.
\nidPartnerStatus / _Value: numeric code & readable label (e.g., Active/Inactive).
\ncanEdit: whether the user has edit rights on this record.
\nisArchived: archive flag on the contact.
\ntotalCount: total items matching the view (use with skip/take for pagination).
\nEntity routing: idEntityType=22 selects Contacts. (For Suppliers, use idEntityType=21.)
\nViews: idViewType controls filtering, sorting, and default columnsโmatch it to the UI view the user selected.
\nPagination: increment skip by take to fetch subsequent pages (e.g., 0, 50, 100โฆ).
\nArchival: set isArchived=true to include archived contacts.
\nColumns override: pass a column array if you need a custom projection; null uses the viewโs defaults.
\nRetrieve detailed information about a specific contact associated with a supplier.
\nGET /ManagePartners/GetContactDetails/{{contactId}}
\ncurl --location '/ManagePartners/GetContactDetails/{{contactId}}' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer {{vault:authToken}}'\n\n{\n \"id\": 48001, // Contact ID\n \"idPartnerCompany\": 45001, // Associated supplier company ID\n \"partnerCompany\": \"Supplier Alpha\", // Supplier company name\n \"email\": \"contact.alpha@example.com\", // Contact email\n \"name\": \"Jane Smith\", // Contact full name\n \"position\": null, // Job title (optional)\n \"phone\": null, // Phone number (optional)\n \"notes\": null, // Additional notes\n \"unsubscribed\": false, // Email subscription status\n \"idPartnerStatus\": 1, // Status ID\n \"partnerStatus\": \"Active\", // Status label\n \"idLanguage\": 2, // Language ID\n \"language\": \"English\", // Preferred language\n \"isArchived\": false, // Whether contact is archived\n \"idCreatedBy\": 10001, // User ID who created the record\n \"createdOn\": \"2025-08-27T09:04:34\", // Creation timestamp\n \"idOwner\": 10001, // User ID who owns the record\n \"idTeam\": [2001], // Associated team(s)\n \"breadcrumbs\": [ // Navigation trail for UI\n {\n \"name\": \"Supplier Alpha\",\n \"route\": \"https://app.prokuria.com/create-company-supplier/45001\",\n \"isActive\": true\n },\n {\n \"name\": \"Jane Smith\",\n \"route\": \"https://app.prokuria.com/create-contact/48001\",\n \"isActive\": false\n }\n ],\n \"idPartnerType\": 2, // Type of partner (e.g., supplier, customer)\n \"canEdit\": true, // Whether the current user can edit\n \"idModifiedBy\": 10001, // User ID who last modified the record\n \"modifiedOn\": \"2025-08-27T09:05:07\",// Last modification timestamp\n \"idSendGridMailLastStatus\": 1, // Last SendGrid mail status ID\n \"sendGridMailLastDate\": \"2025-08-27T09:25:31\" // Last email status update timestamp\n}\n\nUse this method to fetch full details of a contact within a supplier company.
\nThe breadcrumbs array provides navigation context for the UI.
\nSensitive internal flags (showAuditLog, updateCustomFields, etc.) are omitted in this minimal example for clarity.
\nRequires a valid Authorization bearer token.
\nUpdates a partner (contact) linked to a supplier company.
\nAll request fields are mandatory (including those with null).
\nResponse: no body, returns 200 OK on success.
\nMethod: POST
\nURL: /ManagePartners/UpdatePartner/
\nAuth: Bearer {{vault:authToken}}
\nHeaders: Content-Type: application/json
\n{\n \"selectedStatus\": {}, // object (required) - keep empty object if not used\n \"selectedLanguage\": {}, // object (required) - keep empty object if not used\n \"updateCustomFields\": false, // boolean (required)\n \"showDocuments\": false, // boolean (required)\n \"showComments\": false, // boolean (required)\n \"commentsNonEditable\": false, // boolean (required)\n \"showAuditLog\": false, // boolean (required)\n \"canEdit\": false, // boolean (required)\n \"id\": 48001, // int (required) partner/contact id\n \"name\": \"John Doe\", // string (required) contact full name\n \"idPartnerCompany\": 45001, // int (required) supplier/company id\n \"email\": \"john.doe@example.com\", // string (required) valid email\n \"position\": \"Chief Growth Architect\", // string (required)\n \"idLanguage\": 2, // int (required) language id\n \"phone\": null, // string|null (required) use null if unknown\n \"idPartnerStatus\": 1, // int (required) status id (e.g., Active)\n \"notes\": null, // string|null (required)\n \"idPartnerType\": 2, // int (required) partner type id\n \"idOperationalUnit\": null, // int|null (required)\n \"idTeam\": [2501], // array<int> (required) team ids\n \"idOwner\": 10001 // int (required) owner user id\n}\n\ncurl --location '/ManagePartners/UpdatePartner/' \\\n--header 'Authorization: Bearer {{vault:authToken}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"selectedStatus\": {},\n \"selectedLanguage\": {},\n \"updateCustomFields\": false,\n \"showDocuments\": false,\n \"showComments\": false,\n \"commentsNonEditable\": false,\n \"showAuditLog\": false,\n \"canEdit\": false,\n \"id\": 48001,\n \"name\": \"John Doe\",\n \"idPartnerCompany\": 45001,\n \"email\": \"john.doe@example.com\",\n \"position\": \"Chief Growth Architect\",\n \"idLanguage\": 2,\n \"phone\": null,\n \"idPartnerStatus\": 1,\n \"notes\": null,\n \"idPartnerType\": 2,\n \"idOperationalUnit\": null,\n \"idTeam\": [2501],\n \"idOwner\": 10001\n}'\n\nHTTP/1.1 200 OK\n\n\n\n","urlObject":{"path":["ManagePartners","UpdatePartner",""],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c269157b-1599-4c9b-a206-103bce7e482b","name":"UpdatePartner","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:authToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"selectedStatus\": {},\n \"selectedLanguage\": {},\n \"updateCustomFields\": false,\n \"showDocuments\": false,\n \"showComments\": false,\n \"commentsNonEditable\": false,\n \"showAuditLog\": false,\n \"canEdit\": false,\n\n \"id\": {{partnerId}}, // e.g. 48001\n \"name\": \"{{partnerName}}\", // e.g. \"John Orange\"\n \"idPartnerCompany\": {{partnerCompanyId}}, // e.g. 45001\n \"email\": \"{{partnerEmail}}\", // e.g. \"john.orange@example.com\"\n \"position\": \"{{partnerPosition}}\", // e.g. \"Chief Growth Architect\"\n \"idLanguage\": {{languageId}}, // e.g. 2\n \"phone\": {{partnerPhone}}, // null or string\n \"idPartnerStatus\": {{partnerStatusId}}, // e.g. 1\n \"notes\": {{partnerNotes}}, // null or string\n \"idPartnerType\": {{partnerTypeId}}, // e.g. 2\n \"idOperationalUnit\": {{operationalUnitId}}, // null or int\n \"idTeam\": [{{teamId}}], // e.g. [2501]\n \"idOwner\": {{ownerId}} // e.g. 10001\n}","options":{"raw":{"language":"json"}}},"url":"/ManagePartners/UpdatePartner/"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"0ffbc06c-67a4-4831-bafd-dc5e7e7a8caa"},{"name":"GetCompany","id":"8c06a664-d4e7-4f8c-953a-b01d743fec7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:authToken}}"}],"url":"/ManagePartners/GetCompany/{{companyId}}","description":"Note: This endpoint does not return a response body. Use the HTTP status to determine success.
\n
Retrieves full details of a supplier company, including its profile, owner, associated contacts (partners), assigned teams, categories, main contact, available currencies, and audit information.
\nThis method is commonly used to fetch supplier details for viewing or editing.
\nGET /ManagePartners/GetCompany/{{companyId}}
\nHeaders
\nAccept: application/json\nAuthorization: Bearer {{vault:authToken}}\n\nPath Parameters
\n{\n \"id\": 45001, // internal company ID\n \"name\": \"Sample Supplier Ltd\", // company name\n \"taxId\": \"123456\", // tax identifier\n \"phone\": \"+40 712 345 678\", // contact phone\n \"ownerName\": \"John Doe | Account Manager\", // owner information\n \"country\": \"Romania\", // company country\n \"statusName\": \"Active\", // supplier status\n \"partners\": [ // list of associated contacts (employees, reps, etc.)\n {\n \"id\": 48001, // contact ID\n \"email\": \"supplier@example.com\",// contact email\n \"name\": \"Alice Smith\", // contact name\n \"phone\": \"+40 711 111 111\" // optional phone number\n },\n {\n \"id\": 48002, // contact ID\n \"email\": \"contact@example.com\", // contact email\n \"name\": \"Bob Johnson\", // contact name\n \"position\": \"Manager\" // optional position/title\n }\n ],\n \"categories\": [\n {\n \"id\": 47001,\n \"name\": \"Chemical\" // example supplier category\n }\n ],\n \"teams\": [\n { \"key\": 2531, \"value\": \"Team A\" }, // assigned internal team\n { \"key\": 2532, \"value\": \"Team B\" }\n ],\n \"mainContact\": {\n \"key\": 48002,\n \"value\": \"Bob Johnson\" // designates the main contact person\n },\n \"currencies\": [\n { \"key\": 1, \"value\": \"RON\" }, // available/preferred currencies\n { \"key\": 1002, \"value\": \"EUR\" },\n { \"key\": 1003, \"value\": \"USD\" }\n ],\n \"modifiedBy\": {\n \"key\": 10394,\n \"value\": \"Jane Admin\" // last user who updated the record\n },\n \"modifiedOn\": \"2025-06-26T11:18:22.64\" // last modification timestamp\n}\n\nAll IDs in the example above are anonymised for documentation purposes.
\nReal responses will include many additional fields (null values, flags, extended currencies, etc.).
\nThe partners array may contain multiple contacts, each with optional details such as position, phone, or notes.
\nThe mainContact indicates the default person for communications with the supplier.
\nThis method is read-only and does not modify data.
\nThe Contacts folder contains endpoints related to managing individual people associated with companies in Prokuria (suppliers, partners, or internal users). Contacts represent the human link between organisations and the procurement workflows.
\nWithin this section you will find endpoints that allow you to:
\nRetrieve contact details by ID, including name, email, phone, and assigned roles.
\nList contacts associated with a specific supplier or partner company.
\nAccess ownership data (e.g. idOwner, idMainContact) linked to companies and events.
\nUpdate contact information such as status, role, or lead attributes.
\nManage relationships between contacts and their companies, ensuring proper assignment in events or workflows.
\n๐ Contacts are often referenced in supplier/company APIs via idMainContact or idOwner.
\n๐ When retrieving contacts for a company, the API returns their statuses (hs_lead_status, segmentation, etc.), which can be used to roll up company-level classifications.
\n๐ Updates typically require a valid entityId for the contact and return a simple 200 OK on success.
\nThis folder gives you full visibility into people data in Prokuria, enabling you to integrate supplier/user contacts seamlessly into your sourcing workflows, reporting, and CRM synchronisations.
\n","_postman_id":"150bc6f6-8d03-413e-a714-e3173cc3cff0"},{"name":"Entities","item":[{"name":"getView","id":"4309e87c-8e05-4d0a-8422-ff9533d7ce6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:authToken}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"skip\": {{skip}},\n \"take\": {{take}},\n \"sort\": {\n \"selector\": \"{{sortSelector}}\",\n \"desc\": {{isDesc}}\n },\n \"idEntityType\": {{idEntityType}},\n \"idViewType\": {{idViewType}},\n \"isArchived\": {{isArchived}},\n \"columns\": null\n}","options":{"raw":{"language":"json"}}},"url":"/entity/LoadEntityGridView1","description":"Purpose: Fetch paginated rows from a custom entity using a saved grid view.
\nMethod & URL
\nPOST /entity/LoadEntityGridView1
\n\n\nDefault = https://api.prokuria.com/api
\n
Auth
\nBearer token โ Authorization: Bearer {{vault:authToken}}
\n{\n \"skip\": 0, // number of rows to skip (pagination)\n \"take\": 50, // page size (recommended 10โ200)\n \"idEntityType\": 37, // REQUIRED. Internal ID of the *custom entity* type\n \"idViewType\": 95102, // REQUIRED. ID of a saved grid view for that entity\n \"isArchived\": false, // include archived records? (true/false)\n \"columns\": null // optional: array of db column names to force-select; null = view defaults\n}\n\nidEntityType and idViewType are placeholders โ you must use the real values provided by the Prokuria team.
\nUse skip and take for pagination.
\nColumns is mandatory. If \"null\", the server returns the columns defined by the saved view.
\nPOST /entity/LoadEntityGridView1\nAuthorization: Bearer {{vault:authToken}}\nContent-Type: application/json\n{\n \"skip\": 0,\n \"take\": 25,\n \"idEntityType\": {{idEntityType}}, // e.g., 37 (Custom: Equipment)\n \"idViewType\": {{idViewType}}, // e.g., 95102 (View: Active Equipment)\n \"isArchived\": false,\n \"columns\": null\n}\n\n{\n \"columns\": [\n { \"dbColumnName\": \"equip_code\", \"columnHeader\": \"Code\" },\n { \"dbColumnName\": \"equip_name\", \"columnHeader\": \"Name\" },\n { \"dbColumnName\": \"status\", \"columnHeader\": \"Status\" }\n ],\n \"dataSource\": [\n {\n \"id\": 48001, // anonymised\n \"equip_code\": \"EQ-001\",\n \"equip_name\": \"Hydraulic Press\",\n \"status\": \"Active\",\n \"isArchived\": false\n },\n {\n \"id\": 48002,\n \"equip_code\": \"EQ-002\",\n \"equip_name\": \"Laser Cutter\",\n \"status\": \"Active\",\n \"isArchived\": false\n }\n ],\n \"totalCount\": 2 // may be present depending on view config\n}\n\nThis endpoint is entity-agnostic; setting idEntityType to your custom entity switches the dataset accordingly.
\nidViewType should reference a saved grid view that already filters/sorts the data as needed (created in the UI).
\nFor large datasets, iterate with skip += take until youโve retrieved totalCount rows (if provided).
\nSpeak with the Prokuria team to obtain valid idEntityType and idViewType values for your custom entity.
\nDeletes a record from a custom entity.
\nRequires both the recordId (ID of the record to delete) and the entityId (ID of the custom entity that holds the record).
\nโ ๏ธ The operation is irreversible.
\nrecordId (number, required) โ ID of the record to delete (example: 1400708)
\nentityId (number, required) โ ID of the custom entity (example: 100500)
\nBearer token via Authorization: Bearer {{vault:authToken}}
\ncurl --location 'https://api.prokuria.com/api/entity/DeleteEntityRecord/14007/1005' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer {{vault:authToken}}'\n\nHTTP/1.1 200 OK\n\nNo body is returned.
\nMake sure you are passing the correct entityId and recordId before invoking this method.
\nReturns 200 OK on success.
\nIf the record does not exist or the user lacks permissions, an error status code will be returned.
\nโ ๏ธ This endpoint uses the GET method (not DELETE), which may be unexpected for some developers.
\nCreates a new empty record inside a given custom entity.
\nThe record is created without any initial field values.
\nThe API returns the numeric ID of the newly created record (plain text, not JSON).
\nYou can later update the record using the UpdateEntityRecord endpoint.
\nThe entityId identifies the custom entity type where the record will be created.
\nThe null/null placeholders are part of the legacy API path and must remain in the URL.
\nMethod: GET
\nURL:
\n/entity/CreateRecord/{{entityId}}/null/null\n\nHeaders:
\nAccept: application/json\nAuthorization: Bearer {{vault:authToken}}\n\ncurl --location '/entity/CreateRecord/100500/null/null' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer {{vault:authToken}}'\n\n140001\n\n(numeric ID of the newly created record; anonymised example)
\nThis endpoint only creates an empty record.
\nThe response is the recordId (plain text) which you should store and use in later calls.
\nUse the UpdateEntityRecord endpoint to populate the record with data afterwards.
\nThe entityId will be provided by your Prokuria implementation team.
\nPurpose: Fetches one record (by id) from a custom entity. The response includes the recordโs metadata plus the dynamic form schema (fields, sections, subgrids) defined for that entity.
\nEndpoint: POST /entity/GetEntityRecord/
\nAuth: Bearer token (Authorization: Bearer {{vault:authToken}})
\nContent-Type: application/json
\n{\n \"id\": 140754, // required: the record ID to retrieve\n \"idEntityType\": 10500, // optional: the custom entity type ID; may be null for some setups\n \"isReadonly\": false, // optional: retrieve in read-only mode (UI hint)\n \"parentEntityName\": null // optional: parent entity display name; may be null\n}\n\ncurl --location '/entity/GetEntityRecord/' \\\n--header 'Authorization: Bearer {{vault:authToken}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"id\": {{entityId}},\n \"idEntityType\": {{idEntityType}},\n \"isReadonly\": {{isReadonly}},\n \"parentEntityName\": {{parentEntityName}}\n}'\n\nVariable checklist
\n{{vault:authToken}} โ your access token
\n{{entityId}} โ e.g. 14054
\n{{idEntityType}} โ e.g. 1050 (or null)
\n{{isReadonly}} โ false
\n{{parentEntityName}} โ e.g. \"Suppliers\" (or null)
\n{\n \"entityId\": 100001, // custom entity type ID (anonymised)\n \"id\": 45001, // record ID (anonymised)\n \"name\": \"Warehouse A\", // record display name\n \"entityName\": \"Warehouses\", // entity name\n \"schema\": [\n {\n \"type\": \"section\", // section container\n \"idSection\": 20001,\n \"isExpandable\": false\n },\n {\n \"type\": \"textbox\", // field definition\n \"key\": \"name\",\n \"templateOptions\": {\n \"label\": \"Warehouse Name\",\n \"required\": true\n },\n \"defaultValue\": \"Warehouse A\"\n },\n {\n \"type\": \"textbox\",\n \"key\": \"address\",\n \"templateOptions\": {\n \"label\": \"Address\",\n \"required\": false\n }\n },\n {\n \"type\": \"subgrid\", // child records grid\n \"key\": \"subgrid_stock\",\n \"idParentEntity\": 100001,\n \"idChildEntity\": 100002,\n \"idParentRecord\": 45001,\n \"parentEntityName\": \"Warehouse A\"\n }\n ],\n \"breadcrumbs\": [\n { \"name\": \"Warehouses\", \"route\": \".../entity-list/100001\" },\n { \"name\": \"Warehouse A\", \"route\": \".../create-entity/45001\" }\n ],\n \"subgrids\": [\n { \"idParentEntity\": 100001, \"idParentRecord\": 45001, \"idChildEntity\": 100002 }\n ],\n \"canEdit\": true,\n \"isArchived\": false,\n \"publicFormSlug\": \"entity-example-slug\"\n}\n\n\n\nNote: Response structure varies by custom entity schema configured in your Prokuria account (fields, sections, validations, and child subgrids).
\n
Use this endpoint when you need the full schema + data for a single custom entity record (e.g., to render a form or inspect subgrids).
\nidEntityType can be omitted/null in some contexts; include it if your workflow relies on explicit entity typing.
\nThe schema array defines UI/behaviour (sections, fields, subgrids). Actual field keys/labels come from your configuration.
\nCreateRecord: POST /entity/CreateRecord/{{idEntityType}}/null/null โ creates an empty record (returns the new record ID).
\nDeleteEntityRecord: GET /entity/DeleteEntityRecord/{{recordId}}/{{idEntityType}} โ deletes a record (returns 200 OK, no body).
\nThis method saves (creates or updates) an entity record in a custom entity. It requires the entityId and a JSON body with the fields to update.
\nMethod: POST
\nURL: /entity/SaveEntityRecord/{{entityId}}/undefined
\nAuth: Bearer Token ({{vault:authToken}})
\nRequest Body Parameters
\n{\n \"subgrid_4910\": null, // (optional) Example of a subgrid field; depends on schema\n \"name\": \"{{warehouseName}}\", // (required) Warehouse name\n \"address\": null // (optional) Address of the warehouse; depends on schema\n}\n\nExample Request
\n{\n \"subgrid_4910\": null,\n \"name\": \"Dublin Warehouse\",\n \"address\": null\n}\n\nExample Response
\n(no content) \n\n\n\nThe endpoint returns HTTP 200 OK with no response body.
\n
Notes
\nField names in the body depend on the entity schema (as configured in Prokuria).
\nAlways include all required fields, otherwise the save may silently fail.
\nThe entityId determines the entity type you are saving into.
\nThis folder groups together all methods for managing custom entities in Prokuria. Use these endpoints to create, read, update, delete, and view entity records.
\ngetView โ Load data from a custom entity view (with filters, pagination).
\nCreateRecord โ Create an empty record in a custom entity (returns record ID).
\nGetEntityRecord โ Retrieve details of a specific entity record, including schema and fields.
\nUpdateEntityRecord โ Update values in an existing entity record.
\nDeleteEntityRecord โ Delete an entity record by ID (returns 200 OK).
\nTogether, these methods provide full CRUD functionality on custom entities.
\n","_postman_id":"b1fcef5c-3337-4f10-ae14-aad955024a03"},{"name":"Reports","item":[{"name":"GetAdvancedReport","id":"b18abb0e-b84d-415d-ba9f-3db589421600","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:authToken}}"}],"url":"/reports/GetAdvancedReport/{{reportId}}","description":"Use this method to retrieve the contents of a saved report (also called a View) in JSON format.
\nThe API will return both the columns definition (schema) and the data rows of the report.
\nPOST /reports/GetAdvancedReport/{{reportId}}\n\nโ defaults to https://api.prokuria.com/api
\n{{reportId}} โ ID of the report you want to retrieve (integer)
\nBearer Token
\nThe response is a JSON object with two main fields:
\ncolumns โ metadata for each field in the report (technical name, display header, type, format).
\ndata โ actual rows of the report. Each property maps to a dbColumnName from the columns array.
\n{\n \"columns\": [\n {\n \"dbColumnName\": \"partnercompany_id\",\n \"columnHeader\": \"ID\",\n \"fieldType\": 8,\n \"dataType\": \"number\",\n \"format\": \"###0\"\n // numeric internal ID of the supplier/company\n },\n {\n \"dbColumnName\": \"partnercompany_name\",\n \"columnHeader\": \"Name\",\n \"fieldType\": 1\n // supplier/company display name\n },\n {\n \"dbColumnName\": \"partnercompany_partn_country\",\n \"columnHeader\": \"Country\",\n \"fieldType\": 6\n // lookup; see *_Value for human-readable label\n },\n {\n \"dbColumnName\": \"partnercompany_partn_risk\",\n \"columnHeader\": \"Risk\",\n \"fieldType\": 5\n // enum (1=Green, 2=Yellow, 3=Red); see *_Value for label\n },\n {\n \"dbColumnName\": \"partnercompany_recordUrl\",\n \"columnHeader\": \"REPORT_RECORD_LINK\",\n \"fieldType\": 9\n // link to open the record in app context\n }\n ],\n \"data\": [\n {\n \"partnercompany_id\": 45001,\n \"partnercompany_name\": \"Supplier Alpha LTD\",\n \"partnercompany_partn_country\": 1153601,\n \"partnercompany_partn_country_Value\": \"France\",\n \"partnercompany_partn_risk\": 1,\n \"partnercompany_partn_risk_Value\": \"Green\",\n \"partnercompany_recordUrl\": \"/app/partners/45001\",\n \"partnercompany_iban\": \"RO49AAAA1B31007593840000\",\n \"partnercompany_partn_currency\": 1,\n \"partnercompany_partn_currency_Value\": \"EUR\"\n },\n {\n \"partnercompany_id\": 45002,\n \"partnercompany_name\": \"Supplier Beta SRL\",\n \"partnercompany_partn_country\": 1153701,\n \"partnercompany_partn_country_Value\": \"United States of America\",\n \"partnercompany_partn_risk\": 2,\n \"partnercompany_partn_risk_Value\": \"Yellow\",\n \"partnercompany_recordUrl\": \"/app/partners/45002\",\n \"partnercompany_iban\": null,\n \"partnercompany_partn_currency\": null,\n \"partnercompany_partn_currency_Value\": null\n }\n ]\n}\n\nThe report ID ({{reportId}}) must be replaced with the actual ID of the saved report.
\nReport IDs are provided by the Prokuria team when setting up your account and reporting configuration.
\nCollapsing the columns array in your JSON viewer will make it easier to inspect the actual data rows.
\nFor lookup and enum fields, you will typically see both an ID (e.g., partnercompany_partn_risk) and its human-readable label (e.g., partnercompany_partn_risk_Value).
\nLinks returned in partnercompany_recordUrl may be relative or absolute, depending on environment.
\nThe Reports folder groups together endpoints that allow you to retrieve saved reports (Views) configured in your Prokuria account. These endpoints provide structured JSON output containing both the columns metadata and the actual data rows, which can then be used for analysis, integrations, or exports.
\nReports are defined in advance and the report ID is provided by the Prokuria team during setup.
\nThe data returned typically includes both technical identifiers (IDs) and their human-readable labels (via *_Value fields).
\nUseful for integrating Prokuria with BI tools, dashboards, or automated workflows.
\n๐ Use this section whenever you need to pull structured data out of Prokuria for further processing.
\n","_postman_id":"ba55f6cf-f2d1-484e-b4e4-560362982250"}],"event":[{"listen":"prerequest","script":{"id":"da4b5b97-b607-4881-9c09-51f808e81bf3","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"e10f386a-849e-4963-b0d7-da38b172978f","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseURL","value":""},{"key":"authURL","value":""}]}