**Partner organisations only

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.getpenfold.dev/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Penfold Payroll API v4 MCP server": {
    "url": "https://docs.getpenfold.dev/mcp"
  }
}

GET /employers/{employer_id}/employees/{employee_id}/portfolio_summary

O auth2 client credentials

Partner organisations only. A Payroll organisation calling this endpoint receives 405 Method Not Allowed.

Read-only summary of the worker's combined pension pot value and growth.

Path parameters

employer_id string Required
employee_id string Required

Responses

200 application/json

Portfolio summary retrieved successfully.
Hide response attributes Show response attributes object
- total_pot_pence integer Required
  
  Combined current pot value across all accounts, in pence.
- total_growth_pence integer Required
  
  Total growth (pot value minus net contributions), in pence.
401 application/json

Unauthorized, the request requires authentication, and the provided credentials are either missing or incorrect.
Hide response attribute Show response attribute object
- error string
  
  A descriptive error message.
404 application/json

Employee or employer not found, the specified employee_id or employer_id does not match any existing records.
Hide response attribute Show response attribute object
- error string
  
  A descriptive error message.
405 application/json

Method not allowed
Hide response attribute Show response attribute object
- error string
  
  A descriptive error message.

GET /employers/{employer_id}/employees/{employee_id}/portfolio_summary

curl \
 --request GET 'https://payroll-api.getpenfold.dev/v4/employers/{employer_id}/employees/{employee_id}/portfolio_summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "total_pot_pence": 125000,
  "total_growth_pence": 15000
}

Response examples (401)

{
  "error": "Bad request: invalid data provided."
}

Response examples (404)

{
  "error": "Bad request: invalid data provided."
}

Response examples (405)

{
  "error": "Bad request: invalid data provided."
}