Get config – Self-signup admin – Backend API

Get config

Copy Markdown

Open in

GET

/api/studies/{study-id}/self-signup

Current self-signup config/status for the study (short code, enabled, cap, current count), or null if self-signup has never been enabled.

Authorization

bearer

headerAuthorizationBearer <token>

Provide the username and password of the user

study-id*string

*/*

shortCode?string

enabled?boolean

participantRoleName?string

maxParticipants?integer

Formatint32

currentParticipantCount?integer

Formatint32

Example request

curl -X GET 'https://dev.carp.dk/api/studies/string/self-signup'

Example responseSchema

{  "shortCode": "string",  "enabled": true,  "participantRoleName": "string",  "maxParticipants": 0,  "currentParticipantCount": 0}