Position Green API: Questionnaires

Modified on Tue, 21 Jul at 9:40 AM

TABLE OF CONTENTS

Send Questionnaire to a Supplier
Get Questionnaire Status
Get Questionnaire Details

Check the Questionnaire section on our Swagger page.

Send a Questionnaire to a Supplier

Sends a survey questionnaire to a supplier in Position Green Platform.

POST https://api.positiongreen.com/v1/questionnaires/SendQuestionnaire

Request Body Parameters

Name	Required	Type	Description
supplierPrettyId	Yes	string	The pretty ID of the target supplier associated with the tenant.
surveyId	No*	string (uuid)	Unique identifier of the survey. Either `surveyId` or `surveyPrettyId` must be provided.
surveyPrettyId	No*	string	Pretty ID of the survey. Either `surveyId` or `surveyPrettyId` must be provided.
subtitle	No	nullable string	Optional additional title for the questionnaire.
campaignId	No	nullable string (uuid)	Optional campaign identifier.
deadline	No	nullable string (date)	Optional deadline by which the questionnaire should be completed (format: `yyyy-MM-dd`).

Response Example (200 OK)

[
  {
    "questionnaireId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "respondentId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "supplierId": "1f1ec12f-edb6-425a-a2d4-o03bddg1d3c5"
  }
]

Get Questionnaire Status

Retrieves the current status of a specific questionnaire (confirmed or not).

GET https://api.positiongreen.com/v1/questionnaires/GetQuestionnaireStatus

Query Parameters

Name	Type	Description
questionnaireId*	string (uuid)	Required. The unique identifier of the questionnaire to check status for.

Response Example (200 OK)

{
  "status": "Confirmed"
}

Possible status enum values: NotStarted, Started, Confirmed, Removed.

Get Questionnaire Details

Retrieves complete detail information about a specific questionnaire.

GET https://api.positiongreen.com/v1/questionnaires/GetQuestionnaire

Request Body

Name	Type	Description
questionnaireId	string (uuid)	The unique identifier of the questionnaire to retrieve details for.

Response Example (200 OK)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Started",
  "name": "Supplier Sustainability Assessment 2026",
  "url": "https://app.positiongreen.com/surveys/3fa85f64",
  "subtitle": "Annual Audit",
  "createdAt": "2026-01-15T10:00:00Z",
  "lastActivity": "2026-01-20T14:30:00Z",
  "deadline": "2026-12-31",
  "lockState": false,
  "year": {
    "id": "d338b2e8-eecc-476a-ba56-1853494a7ec9",
    "name": "2026"
  },
  "responsible": {
    "id": "6320ea4c-f274-4d0d-a249-3d23c15d0468",
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "survey": {
    "id": "8ba12345-1234-468d-8336-7c2fa240a3c0",
    "name": "ESG Standard Survey"
  },
  "supplier": {
    "id": "1f1ec12f-edb6-425a-a2d4-o03bddg1d3c5",
    "name": "Acme Supplier Logistics",
    "prettyId": "acme-logistics",
    "correlationId": "0f80635f-1215-400b-924a-e365cc601d31"
  },
  "collaborators": [
    {
      "id": "2e0ea5ac-bc44-468d-8336-7c2fa240a3c0",
      "name": "John Smith",
      "email": "john.smith@acme.com"
    }
  ]
}

Responses

200 OK Success	Returns the requested questionnaire information.
400 Bad Request	Validation errors, missing required parameters, or invalid configuration.
401 Unauthorized	Authentication required.
404 Not Found	Questionnaire or supplier not found.
500 Server Error	Internal server error occurred while processing the request.