Get details of a single project

GET

/api/v2/organizations/{organization}/projects/{project}

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project?with_token=false';
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://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project?with_token=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

Example

test-org

project

required

string

Project identifier

Example

test-project

Query Parameters

with_token

required

boolean

Responses

200

The request has succeeded.

application/json

object

required

Project ID

integer

uuid

required

Project UUID

string

name

required

Project name

string

machine_name

required

Project machine name

string

write_token

Write token for API access

string

Example

{
  "id": 123,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Test Project",
  "machine_name": "test-project",
  "write_token": "abc123token"
}

400

The server could not understand the request due to invalid syntax.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}