---
title: "Get a project"
method: GET
path: "/api/v1/projects/{intWellKey}"
tags: ["Projects"]
---

# Get a project

`GET /api/v1/projects/{intWellKey}`

## Request

- Base URL: `https://app.drillerdb.com`
- URL: `https://app.drillerdb.com/api/v1/projects/{intWellKey}`
- Auth: API key in header `X-API-Key`

Get a project Requires an Enterprise-plan API key (X-API-Key header) carrying the projects:read scope.

## Path parameters

- `intWellKey` integer, required

## Response `200`

Project detail.

- ProjectResponse
  - `data` Project, required
    - `id` integer, required
    - `project_number` string, required
    - `title` string, required
    - `status` string, required
    - `priority` integer, nullable
    - `customer_id` integer, nullable
    - `customer_name` string, required
    - `address` Address, required
      - `line1` string, nullable
      - `line2` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `postal_code` string, nullable
    - `drill_type` string, nullable
    - `well_type` string, nullable
    - `created_by` string, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `meta` RequestMeta, required
    - `request_id` string, required
  - `links` ItemLinks, required
    - `self` string, required

## Other responses

- `401`: Missing, invalid, inactive, or expired API key.
- `403`: The API key lacks scope or the company is not entitled to API access.
- `404`: The requested project does not exist in the API key company scope.
- `405`: The path exists but not for this HTTP method. Every route is GET (HEAD and OPTIONS are also accepted).
- `429`: The key exceeded its configured rate limits.
- `503`: The public API schema has not been migrated in this environment yet.

---

[API](https://skmtc.dev/drillerdb/apis/drillerdb-public-apis.md) · [All operations](https://skmtc.dev/drillerdb/apis/drillerdb-public-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/drillerdb/apis/drillerdb-public-apis/revisions/aeb372774d99?raw)