Skip to main content
GET
/
project
Get current project
curl --request GET \
  --url https://api.phare.io/project \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "slug": "luminous-guiding-tower",
  "name": "Luminous Guiding Tower",
  "members": [
    1,
    2,
    3
  ],
  "settings": {
    "use_incident_ai": true,
    "use_incident_merging": true,
    "incident_merging_time_window": 5
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

​
X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

​
X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Query Parameters

​
page
integer
default:1

Page number to show

Example:

1

​
per_page
integer
default:20

Number of resources to return per page

Required range: 1 <= x <= 100
Example:

20

Response

Success, current project retrieved

​
id
number

Project ID

Example:

1

​
slug
string

Project slug

Example:

"luminous-guiding-tower"

​
name
string

Project name

Example:

"Luminous Guiding Tower"

​
members
integer[]

List of team members that are part of this project

Required array length: 1 - 100 elements
Example:
[1, 2, 3]
​
settings
object

Project settings

​
created_at
string<date-time>

Date of creation for the entity

​
updated_at
string<date-time>

Date of last update for the entity