Public client hub payload by share token

GET

/public/projects/{token}

const url = 'https://example.com/api/public/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://example.com/api/public/projects/example

Unauthenticated. Returns milestones with progress, recent ticket/milestone activity (titles and descriptions allowed), and the linked scope survey summary.

Parameters

Path Parameters

token

required

string

>= 8 characters <= 128 characters

Responses

200

Public hub payload

application/json

object

project

required

object

required

string format: uuid

name

required

string

milestones

required

Array<object>

object

key

additional properties

any

activity

required

Array<object>

object

key

additional properties

any

survey

object

code

string

title

string

updated_at

required

string format: date-time

404

Not found

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number