Get Project Details

Retrieves detailed information about a project including all associated vaults, licenses, and license groups.

GET /api/v1/machine/project/:id

Path Parameters

Parameter	Type	Required	Description
`id`	string	Yes	The unique identifier of the project

Headers

Header	Type	Required	Description
`X-API-Key`	string	Yes	Your API key

Response

Success (200 OK)

{
  "id": "507f1f77bcf86cd799439014",
  "name": "Production Infrastructure",
  "externalId": "PROJ-001",
  "description": "Contains all production environment resources",
  "domainTenantId": "507f1f77bcf86cd799439016",
  "vaultsCount": 5,
  "licensesCount": 12,
  "licenseGroupsCount": 3,
  "createdAt": "2026-01-15T10:30:00.000Z",
  "createdBy": "507f1f77bcf86cd799439017",
  "archivedAt": null,
  "vaults": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Production Secrets",
      "isEncrypted": true
    }
  ],
  "licenses": [
    {
      "id": "507f1f77bcf86cd799439012",
      "name": "Enterprise License",
      "type": "internal"
    },
    {
      "id": "507f1f77bcf86cd799439018",
      "name": "Manual License Entry",
      "type": "manual"
    }
  ],
  "licenseGroups": [
    {
      "id": "507f1f77bcf86cd799439013",
      "name": "Development Team Licenses"
    }
  ]
}

Response Fields

Field	Type	Description
`id`	string	The unique identifier of the project
`name`	string	The name of the project
`externalId`	string \| null	Optional external identifier for integration with external systems
`description`	string \| null	A description of the project
`domainTenantId`	string	The domain tenant ID this project is associated with
`vaultsCount`	number	The number of vaults associated with this project
`licensesCount`	number	The number of licenses (both internal and manual) associated
`licenseGroupsCount`	number	The number of license groups associated
`createdAt`	string	ISO 8601 timestamp when the project was created
`createdBy`	string	ID of the user who created the project
`archivedAt`	string \| null	ISO 8601 timestamp when archived (null if active)
`vaults`	array	Array of vault objects associated with the project
`licenses`	array	Array of license objects (both internal and manual)
`licenseGroups`	array	Array of license group objects

Vault Object Fields

Field	Type	Description
`id`	string	The unique identifier of the vault
`name`	string	The name of the vault
`isEncrypted`	boolean \| null	Whether the vault uses client-side encryption

License Object Fields

Field	Type	Description
`id`	string	The unique identifier of the license
`name`	string \| null	The name of the license
`type`	string	License type: "internal" or "manual"

License Group Object Fields

Field	Type	Description
`id`	string	The unique identifier of the license group
`name`	string	The name of the license group

Error Responses

401 Unauthorized - Invalid or missing API key

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key. Please provide your API key in the X-API-Key header."
  }
}

404 Not Found - Project not found in your organization

{
  "error": {
    "code": "project_not_found",
    "message": "The project with ID \"507f1f77bcf86cd799439014\" was not found in your organization or you do not have access to it."
  }
}

Example Request

curl -X GET "https://r4.dev/api/v1/machine/project/507f1f77bcf86cd799439014" \
  -H "X-API-Key: rk_abc123def456.ghijklmnopqrstuvwxyz1234567890abcdef"

Use Cases

Infrastructure automation: Fetch project context when provisioning resources
Reporting: Build dashboards showing project resource allocation
Integration: Sync project information with external project management tools
Auditing: Track which resources are associated with which projects
Cost allocation: Understand resource distribution across projects for billing purposes

Notes

The project must belong to your organization
The API key must have access to the tenant associated with the project
Archived projects are still accessible through this endpoint
Only non-archived vaults, licenses, and license groups are included in the response