Projects API

Manage your project and members programmatically.

API Naming

In the API, projects are referred to as "teams" (/api/teams) for backward compatibility. The API endpoints and parameter names (e.g., teamId) remain unchanged.

Endpoints Overview

Method	Endpoint	Description
POST	/api/teams	Create a new project
GET	/api/teams	Get all projects for current user
GET	/api/teams/:id	Get project by ID
PUT	/api/teams/:id	Update project settings
DELETE	/api/teams/:id	Delete project
GET	/api/teams/members	List project members
POST	/api/teams/members/invite	Invite new member
DELETE	/api/teams/members/:id	Remove member
PATCH	/api/teams/members/:id/role	Update member role
GET	/api/teams/invitations/my	Get my pending invitations
POST	/api/teams/invitations/:id/accept	Accept invitation
POST	/api/teams/invitations/:id/reject	Reject invitation
DELETE	/api/teams/members/:id/invitation	Cancel invitation
GET	/api/teams/activity	Get project activity

note

All project endpoints require JWT authentication.

---

Create Project

POST /api/teams

Create a new project with the authenticated user as owner.

Request Body

Field	Type	Required	Description
name	string	Yes	Project name
slug	string	No	URL-friendly project identifier

Response

{
  "id": "team_abc123",
  "name": "Acme Corporation",
  "slug": "acme-corp",
  "createdAt": "2024-06-01T00:00:00Z"
}

---

Get User Projects

GET /api/teams

Get all projects where the user is an owner or member, including their personal project.

Response

{
  "data": [
    {
      "id": "team_abc123",
      "name": "Acme Corporation",
      "slug": "acme-corp",
      "isPersonal": false,
      "role": "owner",
      "memberCount": 5,
      "createdAt": "2024-06-01T00:00:00Z"
    }
  ]
}

Example

curl https://api.rynko.dev/api/teams \
  -H "Authorization: Bearer <jwt_token>"

---

Get Project by ID

GET /api/teams/:id

Get details about a specific project.

Path Parameters

Parameter	Type	Description
id	string	Project ID (referred to as teamId in the API)

Response

{
  "id": "team_abc123",
  "name": "Acme Corporation",
  "slug": "acme-corp",
  "memberCount": 5,
  "createdAt": "2024-06-01T00:00:00Z"
}

---

Update Project

PUT /api/teams/:id

Update project settings. Only project owner can update.

Path Parameters

Parameter	Type	Description
id	string	Project ID (referred to as teamId in the API)

Request Body

Field	Type	Required	Description
name	string	No	Project name

Response

Returns the updated project object.

Example

curl -X PUT https://api.rynko.dev/api/teams/team_abc123 \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation Updated"
  }'

---

Delete Project

DELETE /api/teams/:id

Soft delete a project. Only project owner can delete.

warning

Personal projects cannot be deleted via API - they are automatically deleted when the user account is deleted.

Path Parameters

Parameter	Type	Description
id	string	Project ID (referred to as teamId in the API)

Response

{
  "message": "Project deleted successfully"
}

---

List Project Members

GET /api/teams/members

Get all members of the current user's project.

Response

{
  "data": [
    {
      "id": "user_abc123",
      "email": "john@acme.com",
      "name": "John Doe",
      "role": "owner",
      "joinedAt": "2024-06-01T00:00:00Z"
    },
    {
      "id": "user_def456",
      "email": "jane@acme.com",
      "name": "Jane Smith",
      "role": "admin",
      "joinedAt": "2024-07-15T00:00:00Z"
    }
  ]
}

Member Roles

Role	Description
owner	Full access, can delete project
admin	Full access except project deletion
member	Can create and use templates
viewer	Read-only access

Example

curl https://api.rynko.dev/api/teams/members \
  -H "Authorization: Bearer <jwt_token>"

---

Invite Member

POST /api/teams/members/invite

Send an invitation to join your project.

Request Body

Field	Type	Required	Description
email	string	Yes	Email address to invite
role	string	No	Role to assign (default: member)

Request Example

{
  "email": "newmember@acme.com",
  "role": "member"
}

Response

{
  "id": "invite_abc123",
  "email": "newmember@acme.com",
  "role": "member",
  "status": "pending",
  "expiresAt": "2025-01-22T00:00:00Z"
}

---

Remove Member

DELETE /api/teams/members/:id

Remove a member from your project. Only project owner can remove members.

Path Parameters

Parameter	Type	Description
id	string	Member user ID

Response

{
  "message": "Member removed successfully"
}

---

Update Member Role

PATCH /api/teams/members/:id/role

Change a member's role. Only project owner can update roles.

Path Parameters

Parameter	Type	Description
id	string	Member user ID

Request Body

Field	Type	Required	Description
role	string	Yes	New role: admin, member, or viewer

Response

Returns the updated member object.

Example

curl -X PATCH https://api.rynko.dev/api/teams/members/user_def456/role \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin"
  }'

---

Get My Invitations

GET /api/teams/invitations/my

Get all pending project invitations for the current user.

Response

{
  "data": [
    {
      "id": "invite_abc123",
      "teamId": "team_xyz789",
      "teamName": "Acme Corporation",
      "role": "member",
      "invitedBy": "john@acme.com",
      "expiresAt": "2025-01-22T00:00:00Z"
    }
  ]
}

---

Accept Invitation

POST /api/teams/invitations/:id/accept

Accept a pending project invitation.

Path Parameters

Parameter	Type	Description
id	string	Invitation ID

Response

{
  "message": "Invitation accepted successfully"
}

---

Reject Invitation

POST /api/teams/invitations/:id/reject

Reject a pending project invitation.

Path Parameters

Parameter	Type	Description
id	string	Invitation ID

Response

{
  "message": "Invitation rejected successfully"
}

---

Cancel Invitation

DELETE /api/teams/members/:id/invitation

Cancel a pending invitation. Only project owner can cancel.

Path Parameters

Parameter	Type	Description
id	string	Invitation ID

Response

{
  "message": "Invitation cancelled successfully"
}

---

Get Project Activity

GET /api/teams/activity

Get recent activity for the current user's project.

Response

{
  "data": [
    {
      "type": "member_joined",
      "user": "Jane Smith",
      "timestamp": "2024-07-15T00:00:00Z"
    },
    {
      "type": "template_created",
      "template": "Invoice Template",
      "user": "John Doe",
      "timestamp": "2024-06-15T00:00:00Z"
    }
  ]
}

---

Error Codes

Code	Description
ERR_TEAM_001	Project not found
ERR_TEAM_002	A project with this slug already exists
ERR_TEAM_003	You are not the owner of this project
ERR_TEAM_004	Personal projects cannot be deleted directly
ERR_TEAM_005	Personal project slug cannot be changed
ERR_TEAM_006	This is not a personal project
ERR_TEAM_007	User is already a member of this project
ERR_TEAM_008	An invitation has already been sent to this user
ERR_TEAM_009	Invitation not found
ERR_TEAM_010	This invitation has expired
ERR_TEAM_011	Project member not found
ERR_TEAM_012	You cannot remove yourself from the project

---

Related: Project Management | Users API