Get a project by id or key

GET

/api/v1/projects/{projectIdOrKey}

const url = 'https://app.avera.io/api/v1/projects/example';
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

Parameters

Path Parameters

projectIdOrKey

required

string

Responses

200

*/*

object

required

string format: uuid

key

required

string

name

required

string

description

string | null

status

required

string

Allowed values: ACTIVE ARCHIVED TEMPLATE

templateId

string | null

defaultBranchId

string | null format: uuid

isDefault

required

boolean

createdAt

required

string format: date-time

createdBy

required

string format: uuid

modifiedAt

required

string format: date-time

modifiedBy

required

string format: uuid