Read form qualification

GET /api/v1/forms/{formId}/qualification

Returns draft qualification. Publication is a separate operation.

Authorization

Use x-api-key with an active organization-bound API key. Its holder keeps their current Organization, CASL and resource permissions.

Role in the organization	Access
OWNER	Allowed
ADMIN	Allowed
MEMBER	Head of Sales only — otherwise 403

Requirement	Rule
Business role	Owner, admin or Head of Sales; setter and closer roles do not grant access
Resource scope	Organization bound to the verified key
Participation	None
Resource state	Published valid draft for publication; otherwise the command determines state

Path parameters

Parameter	Type	Required	Description
formId	UUID	yes	Form in the key’s organization

Example

bash

curl -X GET "https://your-school.cohorte.app/api/v1/forms/{formId}/qualification" \
  -H "x-api-key: YOUR_API_KEY"

Response

Success: 200. 400 invalid_request for malformed input or missing key; 401 unauthorized for invalid authentication; 403 forbidden for permission refusal; 404 not_found for missing or other-organization resources; 409 conflict for a conflicting state; 500 internal_error for an unexpected failure.

Response fields

The envelope has success, data, and correlationId. data contains the draft qualification settings, or null before configuration.

Example response

json

{
  "success": true,
  "data": null,
  "correlationId": "00000000-0000-4000-8000-000000000002"
}

Notes

Returns draft qualification. Publication is a separate operation.

Read form qualification

Read form qualification

Authorization

Path parameters

Example

Response

Response fields

Example response

Notes

Related

Authorization

Path parameters

Example

Response

Response fields

Example response

Notes

Related