> ## Documentation Index > Fetch the complete documentation index at: https://docs.mycreditapp.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get private record loans > Returns loan-related metrics for the private record. #### [Authorization scenarios](/content/developer-guide/introduction/authorization#scenarios) | Guest | Host | Self | |-------|------|------| | ❌ | ❌ | ✅ | ## OpenAPI ````yaml /content/developer-guide/api-reference/openapi_v1.json get /private-records/{record_id}/metrics/loans openapi: 3.1.0 info: title: API - V1 version: 1.0.0 servers: - url: https://api.mycreditapp.ai/v1-beta security: [] paths: /private-records/{record_id}/metrics/loans: get: tags: - Private Record Metrics summary: Get private record loans description: |- Returns loan-related metrics for the private record. #### [Authorization scenarios](/content/developer-guide/introduction/authorization#scenarios) | Guest | Host | Self | |-------|------|------| | ❌ | ❌ | ✅ | operationId: get_private_record_loans_private_records__record_id__metrics_loans_get parameters: - name: record_id in: path required: true schema: type: string format: uuid description: >- Unique identifier of the [private record](https://docs.mycreditapp.ai/api-reference/private-records/get-private-records) examples: - b25e7b65-e46a-40d5-a0f2-0de8c2b354aa title: Record Id description: >- Unique identifier of the [private record](https://docs.mycreditapp.ai/api-reference/private-records/get-private-records) - name: date_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter loans from this date (inclusive) examples: - '2025-01-01' title: Date From description: Filter loans from this date (inclusive) - name: date_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter loans up to this date (inclusive) examples: - '2025-12-31' title: Date To description: Filter loans up to this date (inclusive) - name: order_by in: query required: false schema: enum: - date - loan type: string description: >- Field by which to order the loan results (e.g., date, original_loan) default: date title: Order By description: Field by which to order the loan results (e.g., date, original_loan) - name: order_dir in: query required: false schema: enum: - asc - desc type: string description: >- Direction to order the loan results (asc for ascending, desc for descending) default: desc title: Order Dir description: >- Direction to order the loan results (asc for ascending, desc for descending) - name: Requester-Organization-ID in: header required: true schema: type: string format: uuid description: | The unique identifier of the organization making the request. **This ID is used to authorize the requester within the system**. examples: - 054b4106-174b-46b0-97f8-86d8d7b6f0af title: Requester-Organization-Id description: | The unique identifier of the organization making the request. **This ID is used to authorize the requester within the system**. - name: Target-Organization-ID in: header required: true schema: type: string format: uuid description: > The unique identifier of the organization that is the target of the request. The `Target-Organization-ID` may match the `Requester-Organization-ID` if the requester accesses their own resources. If the `Target-Organization-ID` differs from the `Requester-Organization-ID`, the requester can access third-party resources **if the requester has a connection with the target organization and is authorized to perform such actions**. examples: - 123e4567-e89b-12d3-a456-426614174000 title: Target-Organization-Id description: > The unique identifier of the organization that is the target of the request. The `Target-Organization-ID` may match the `Requester-Organization-ID` if the requester accesses their own resources. If the `Target-Organization-ID` differs from the `Requester-Organization-ID`, the requester can access third-party resources **if the requester has a connection with the target organization and is authorized to perform such actions**. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PrivateRecordLoansList' '400': description: Bad Request content: application/json: example: detail: - loc: [] msg: Unsupported CRUD operation! type: request code: unsupported_crud_operation schema: $ref: '#/components/schemas/APIError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Token is required! type: token code: token_required - loc: [] msg: The token has expired! type: token code: token_expired - loc: [] msg: Invalid token! type: token code: invalid_token '403': description: Forbidden content: application/json: example: detail: - loc: [] msg: Access denied! type: request code: access_denied - loc: [] msg: This feature is not included in the current package! type: feature code: feature_is_not_included_in_current_package schema: $ref: '#/components/schemas/APIError' '404': description: Not Found content: application/json: example: detail: - loc: [] msg: Account not found! type: request code: account_not_found - loc: [] msg: Organization not found! type: request code: organization_not_found - loc: [] msg: Private record not found! type: request code: private_record_not_found schema: $ref: '#/components/schemas/APIError' '409': description: Conflict content: application/json: example: detail: - loc: [] msg: >- The account is in the process of being deleted! The Account's email can only be reused after its data has been completely deleted. The removal process may take up to 24 hours. type: request code: account_being_deleted - loc: [] msg: >- The organization is in the process of being deleted! The removal process may take up to 24 hours. type: request code: organization_being_deleted schema: $ref: '#/components/schemas/APIError' '413': description: Request Entity Too Large content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: The request is too large! type: request code: request_too_large '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: - string - 0 msg: string type: string code: validation_error '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Error processing request, please try later! type: try_later code: internal_conflict_error '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Service is under maintenance, please try later! type: maintanance code: service_under_maintenance security: - Token: [] components: schemas: PrivateRecordLoansList: properties: items: items: $ref: '#/components/schemas/PrivateRecordLoan' type: array title: Items description: List of loans total_items: type: integer minimum: 0 title: Total Items description: Total number of loans examples: - 1 - 25 - 50 type: object required: - items - total_items title: PrivateRecordLoansList APIError: properties: detail: items: $ref: '#/components/schemas/ErrorItem' type: array title: Detail description: > List of returned errors. **All unsuccessful error codes except code `422` can only contain 1 element in the list**. type: object required: - detail title: APIError PrivateRecordLoan: properties: id: type: string format: uuid title: Id description: Unique identifier of the loan record examples: - 523e4567-e89b-12d3-a456-426614174004 date: type: string format: date title: Date description: Date of the loan record examples: - '2025-12-01' loan: type: integer title: Loan description: The loan amount examples: - 50000 - 75500 created_at: type: string format: date-time title: Created At description: Timestamp when the loan record was created examples: - '2025-12-01T12:00:00.123456' updated_at: type: string format: date-time title: Updated At description: Timestamp when the loan record was last updated examples: - '2025-12-02T12:00:00.123456' type: object required: - id - date - loan - created_at - updated_at title: PrivateRecordLoan ErrorItem: properties: loc: items: anyOf: - type: string - type: integer type: array title: Loc description: | Shows the dynamic location of the current error. If an empty array is returned, the error is static. examples: - - body - date_field - 0 - - header - Authorization msg: type: string title: Msg description: | A human-readable message providing more details about the error. examples: - Token is required! - Invalid token! type: type: string title: Type description: > A string indicating the type of error. **The list is not fixed, so it's necessary to pay attention to the possible type for a specific error**. examples: - token - request - try_later code: type: string title: Code description: > Unique text error code identifying the error. **The list is not fixed, so it's necessary to pay attention to the possible code for a specific error**. examples: - token_required - invalid_token - access_denied type: object required: - loc - msg - type - code title: ErrorItem securitySchemes: Token: type: http description: >- [Bearer authentication](/content/developer-guide/introduction/authentication) using a JWT token. Provide a valid access token. Authorization header format: `Authorization: Bearer `. scheme: bearer ````