Project

LIVE

https://app.polarix.io

GET

/api/{version}/projects/{project_id}

Retrieves a Project based on the {project_id} path parameter. Project ID is retrieved by calling the "Project List" endpoint

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

version

number

required

Target Polarix.io API version

Example:

1.0

project_id

string

required

Project ID retrieved by calling the "Project List" endpoint

Example:

6582ed0344adfe123d04f772

Header Params

x-api-key

string

required

Example:

1234abcd

string

optional

Use text/xml if XML is required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://app.polarix.io/api/1.0/projects/6582ed0344adfe123d04f772' \
--header 'x-api-key: 1234abcd' \
--header 'Accept: application/json'

Responses

🟢200Success — JSON

application/json

Body

_id

string

required

integer

required

title

string

required

description

string

optional

therapy_area

string

optional

created_at

string

required

updated_at

string

required

version

integer

required

icon

string

optional

cover

string

optional

Example

{
    "_id": "6582ed0344adfe123d04f772",
    "id": 1,
    "title": "Project Title",
    "description": "Project Description",
    "therapy_area": null,
    "created_at": "2023-12-20T13:32:51.886000Z",
    "updated_at": "2023-12-20T13:32:51.886000Z",
    "version": 1,
    "icon": "projects/60913ae5c03dx.png",
    "cover": "https://lhg-digital.s3.amazonaws.com/polarixv2/projects/60913ae5785dx.png"
}

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML

Project List

Project Structure