Skip to main content
GET
/
api
/
adm
/
companyProjects
/
{id}
Get Company Project Details
curl --request GET \
  --url https://localhost:44371/api/adm/companyProjects/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Fetches comprehensive project information including general settings, payment processor configuration, security settings, and associated users. Used when displaying project details in admin dashboards or loading project configuration for editing.

​
Input

  • Path Parameter: id (guid, required) — Unique identifier of the project to retrieve.
  • Query Parameters: model (CompanyProjectEntryQueryRequest, optional) — Options for controlling detail level.

​
Output

Returns a CompanyProjectEntryQueryResponse containing the complete project details.

​
Example Request

GET /api/admin/companyProjects/7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "data": {
    "id": "7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a",
    "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "E-Commerce Application",
    "description": "Main online store payment processing",
    "returnUrl": "https://example.com/payment/return",
    "cancelUrl": "https://example.com/payment/cancel",
    "isActive": true,
    "createdDate": "2025-10-15T09:00:00Z"
  }
}

​
Errors

  • 404 Not Found — No project exists with the specified ID.
  • 401 Unauthorized — Missing or invalid authentication token.
  • 403 Forbidden — User does not have permission to access this project.

​
Notes

  • Response includes all project configuration including sensitive payment processor credentials.
  • Use this endpoint to populate edit forms or display project details.
  • Project details include nested objects for payment processor and security settings.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string<guid>
required

The unique identifier of the project to retrieve.

Query Parameters

​
Id
string<guid>

The identifier of the project to retrieve.

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Represents the response returned when retrieving a specific project entry.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entry
object

The project entry that matches the supplied identifier.

Example:
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dateCreated": "2025-10-30T10:30:00Z",
  "isActive": true,
  "dateModified": "2025-10-30T15:45:00Z"
}