Retrieve a project

GET

/projects/{projectId}

const url = 'https://docs.ywork.dev/api/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://docs.ywork.dev/api/v1/projects/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

projectId

required

string

Unique identifier of the project (e.g. prj_...).

Responses

200

The requested project.

application/json

object

required

string

object

required

string

Allowed value: project

name

required

string

key

required

string

task_count

integer

created_at

required

string format: date-time

updated_at

string format: date-time

Example

{
  "id": "prj_8Hs2Kd0aZq",
  "object": "project",
  "name": "Website redesign",
  "key": "WEB",
  "task_count": 12
}

401

No valid API key was provided.

application/json

object

error

required

object

type

required

A broad category for the error.

string

Allowed values: authentication_error invalid_request_error rate_limit_error api_error

code

required

A short machine-readable code for the specific error.

string

message

required

A human-readable description of the error.

string

request_id

A unique identifier for the request, useful for support.

string

Example

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No API key provided. Send your key as a bearer token in the Authorization header.",
    "request_id": "req_9f2a1c7b4e"
  }
}

404

The requested resource does not exist.

application/json

object

error

required

object

type

required

A broad category for the error.

string

Allowed values: authentication_error invalid_request_error rate_limit_error api_error

code

required

A short machine-readable code for the specific error.

string

message

required

A human-readable description of the error.

string

request_id

A unique identifier for the request, useful for support.

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such resource.",
    "request_id": "req_4b8e0d2a71"
  }
}