Project List - Polarix.io

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:

Header Params

x-api-key

string

required

API Key generated from the Settings panel in Polarix.io

Example:

b062ab000e9456748b941cd5b1658899

Accept

string

optional

application/json or application/xml

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://app.polarix.io/api/1.0/projects' \
--header 'x-api-key: b062ab000e9456748b941cd5b1658899' \
--header 'Accept: application/json'

Responses

🟢200Success — JSON

application/json

Body

array of:

name

string

required

name

email

string

required

email

id

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"
    },
    {
        "_id": "6548ebee4319e20f92018562",
        "id": 2,
        "title": "Second Project Title",
        "description": "Second Project Description",
        "therapy_area": null,
        "created_at": "2023-11-06T12:16:15.000000Z",
        "updated_at": "2023-12-20T13:32:16.886000Z",
        "version": 2,
        "icon": "projects/620f865fa9f01.png",
        "cover": "https://lhg-digital.s3.amazonaws.com/polarixv2/projects/60913ae5785dx.png"
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML