Skip to main content
GET
/
api
/
projects
/
:projectId
Get Project
curl --request GET \
  --url https://api.example.com/api/projects/:projectId
{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "program_id": "<string>",
    "is_public": true,
    "user_id": "<string>",
    "username": "<string>",
    "avatar_url": "<string>",
    "latestVersion": 123,
    "latestVersionDate": "<string>",
    "socials": {
      "twitter": "<string>",
      "discord": "<string>",
      "telegram": "<string>",
      "github": "<string>",
      "website": "<string>"
    },
    "apiKeyCount": 123,
    "isOwner": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "error": "<string>"
}

​
Overview

Fetch comprehensive details about a project including metadata, latest IDL version, social links, and ownership information.

​
Path Parameters

​
projectId
string
required
The unique identifier of the project

​
Authentication

This endpoint supports optional authentication. Private projects require authentication and ownership. 
Authorization: Bearer <jwt_token>

​
Response

​
project
object
Detailed project information

​
Example Request

curl -X GET "https://api.orquestra.so/api/projects/proj_abc123" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

​
Example Response

{
  "project": {
    "id": "proj_abc123",
    "name": "Token Swap Program",
    "description": "A decentralized token swap protocol with automated market making",
    "program_id": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
    "is_public": true,
    "user_id": "user_xyz789",
    "username": "developer",
    "avatar_url": "https://avatars.github.com/u/123456",
    "latestVersion": 3,
    "latestVersionDate": "2024-03-20T14:45:00.000Z",
    "socials": {
      "twitter": "https://twitter.com/tokenswap",
      "discord": "https://discord.gg/tokenswap",
      "telegram": "https://t.me/tokenswap",
      "github": "https://github.com/org/token-swap",
      "website": "https://tokenswap.io"
    },
    "apiKeyCount": 2,
    "isOwner": true,
    "created_at": "2024-03-15T10:30:00.000Z",
    "updated_at": "2024-03-20T14:45:00.000Z"
  }
}

​
Error Responses

​
error
string
Error message describing what went wrong

​
Common Errors

{
  "error": "Project not found"
}
The specified project ID does not exist or has been deleted.
{
  "error": "Access denied"
}
The project is private and you don’t have permission to view it. Only the project owner can access private projects.
{
  "error": "Failed to get project"
}
The server encountered an error while fetching the project. This is typically a temporary issue.

​
Notes

Private project access - Private projects can only be accessed by their owner. Attempting to access someone else’s private project will return a 403 error.
The apiKeyCount field is only populated when the authenticated user is the project owner. Other users will see 0.
Use the latestVersion and latestVersionDate fields to track IDL updates for your project.

Build docs developers (and LLMs) love

Get started for freeTalk to us