Project

Operations

GET/v1/projects/specGET/v1/projectsPOST/v1/projectsGET/v1/projects/{projectId}DELETE/v1/projects/{projectId}PATCH/v1/projects/{projectId}

---

OpenAPI Spec

GET

/v1/projects/spec

Get OpenAPI 3.1.0 spec for Project API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/projects/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List Projects

GET

/v1/projects

List Projects

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

number

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"number": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/projects

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

number

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new Project

POST

/v1/projects

Create a new Project

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"number": "string",

"externalId": null

}

Responses

Project found

Content-Type

application/json

{

"id": 0,

"number": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/projects

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a Project

GET

/v1/projects/{projectId}

Get a Project by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

projectId*

Typeinteger

Required

formatint32

Responses

Project found

Content-Type

application/json

{

"id": 0,

"number": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/projects/{projectId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

projectId*

Samples

cURL

JavaScript

PHP

Python

---

Delete a Project

DELETE

/v1/projects/{projectId}

Delete a Project by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

projectId*

Typeinteger

Required

formatint32

Responses

Successfully removed

DELETE

/v1/projects/{projectId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

projectId*

Samples

cURL

JavaScript

PHP

Python

---

Update a Project

PATCH

/v1/projects/{projectId}

Update a Project by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

projectId*

Typeinteger

Required

formatint32

Request Body

application/json

{

"number": "string",

"externalId": "string"

}

Responses

Project found

Content-Type

application/json

{

"id": 0,

"number": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/projects/{projectId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

projectId*

Body

Samples

cURL

JavaScript

PHP

Python

---