Get project details

GET
/projects/{projectId}

Returns one project with opportunity_count, the number of opportunities filed under it, drafts included and deleted ones not. List them with GET /opportunities and projectId.

Authorization

apiKey
Authorization<token>

API key as Bearer token: Authorization: Bearer

In: header

Path Parameters

projectId*string

ID of the project, as returned by GET /projects or POST /projects.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://terac.com/api/external/v2/projects/string"
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "created_at": "string",
  "dashboard_url": "string",
  "opportunity_count": 0
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required. Include Authorization: Bearer <key> header."
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This account is not permitted to use the API."
  }
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 61 seconds."
  }
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Create a project POST

Creates a project to file opportunities under. Every opportunity belongs to one, so pass the returned `id` as `project_id` to `POST /opportunities`. The `slug` is generated from `name` with a unique suffix, and each call creates a new project even when the name is already in use.

Update a project PATCH

Renames a project. `name` is the only field you can change, and a request without it returns 400. The `slug` and `dashboard_url` stay the same.