/v1/projects/{projectId}

GET

const url = 'https://service.testing.nairon.cloud/v1/projects/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://service.testing.nairon.cloud/v1/projects/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyHeader

Parameters

Path Parameters

projectId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

Responses

200

Default Response

application/json

object

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

organizationId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

name

required

string

description

required

Any of:

string
null

string

status

required

string

Allowed values: active archived paused

plan

required

string

Allowed values: free starter growth pro enterprise

type

required

string

Allowed values: hotline platform

mode

required

string

Allowed values: simple advanced

channels

required

Array<string>

Allowed values: phone website

industry

required

Any of:

string
null

string

createdAt

required

string

updatedAt

required

string

Example

{
  "status": "active",
  "plan": "free",
  "type": "hotline",
  "mode": "simple",
  "channels": [
    "phone"
  ]
}