Projects
List projects with search and pagination
Authorization
bearerAuth Session JWT or OAuth2 access token
In: header
Query Parameters
Pagination cursor
Number of items per page (1-100)
Search by name
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/projects"{
"data": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"customer_id": "string",
"hourly_rate": "string",
"currency": "string",
"active": true,
"created_at": "string",
"updated_at": "string",
"customer": {
"id": "string",
"name": "string",
"email": "string"
}
}
],
"meta": {
"count": 0,
"next_cursor": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}Create a new project
Authorization
bearerAuth Session JWT or OAuth2 access token
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"data": {
"id": "string",
"organization_id": "string",
"name": "string",
"customer_id": "string",
"hourly_rate": "string",
"currency": "string",
"active": true,
"created_at": "string",
"updated_at": "string",
"customer": {
"id": "string",
"name": "string",
"email": "string"
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}Get a single project by ID
Authorization
bearerAuth Session JWT or OAuth2 access token
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string"{
"data": {
"id": "string",
"organization_id": "string",
"name": "string",
"customer_id": "string",
"hourly_rate": "string",
"currency": "string",
"active": true,
"created_at": "string",
"updated_at": "string",
"customer": {
"id": "string",
"name": "string",
"email": "string"
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}Update project fields
Authorization
bearerAuth Session JWT or OAuth2 access token
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/projects/string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "string",
"organization_id": "string",
"name": "string",
"customer_id": "string",
"hourly_rate": "string",
"currency": "string",
"active": true,
"created_at": "string",
"updated_at": "string",
"customer": {
"id": "string",
"name": "string",
"email": "string"
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}Delete a project by ID
Authorization
bearerAuth Session JWT or OAuth2 access token
In: header
Path Parameters
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/projects/string"{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}{
"error": {
"code": "string",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}