Get project settings

GET

/api/v1/projects/{projectIdOrKey}/settings

const url = 'https://app.avera.io/api/v1/projects/example/settings';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.avera.io/api/v1/projects/example/settings

Parameters

Path Parameters

projectIdOrKey

required

string

Responses

200

*/*

object

numbering

required

object

scheme

required

string

Allowed values: TYPE_ONLY PROJECT_PREFIX CUSTOM

projectPrefix

string | null

separator

required

string

padDigits

required

integer format: int32

perTypeSequences

required

boolean

customPattern

string | null

defaultAiModel

string | null

validation

required

object

requirementItemType

string | null

testItemType

string | null

documents

required

object

headingNumbering

required

boolean