---
title: "Get team payment"
method: GET
path: "/v2/team_payments/{team_payment_id}"
tags: ["team_payments"]
---

# Get team payment

`GET /v2/team_payments/{team_payment_id}`

## Request

- Base URL: `https://api.hubstaff.com`
- URL: `https://api.hubstaff.com/v2/team_payments/{team_payment_id}`
- Auth: OAuth 2
  - Authorization code: `https://account.hubstaff.com/authorizations/new`
  - Token URL: `https://account.hubstaff.com/access_tokens` scopes: `hubstaff:read`, `hubstaff:write`
- TypeScript: <https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/docs/v2/team_payments/:team_payment_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the team payment with the given ID.

## Path parameters

- `team_payment_id` integer, required

## Response `200`

A team payment

- object
  - `team_payment` TeamPayment: TeamPayment model
    - `id` integer, required: Payment ID
    - `created_at` string, date-time, required: When the record was created
    - `updated_at` string, date-time, required: When the record was last updated
    - `organization_id` string, required: Organization ID
    - `start_date` string, date, required: Start date period for team payment
    - `stop_date` string, date, required: End date period for team payment
    - `blame_user_id` integer: User ID who made the payment
    - `note` string: A note for this team payment
    - `tracked` integer, required: Total time worked in seconds
    - `amount` string, required: Payment amount
    - `currency` string, required: Payment currency
    - `payment_source` string, required: Payment source type
    - `paid_via_payroll` boolean, required: Paid via the payroll gateway
    - `unpaid_amount` string: The amount left to be paid
    - `payment_gateway` string: The payroll gateway used to pay
    - `payment_complete` boolean: Payment completion status
    - `next_payment_at` string, date-time: The next time this payment will be retried
    - `details` TeamPaymentDetail[], required: Team payment details
      - `id` integer, required: Payment detail ID
      - `user_id` integer, required: User ID
      - `project_id` integer: Project ID
      - `task_id` integer: Task ID
      - `date` string, date, required: Date for the time worked
      - `tracked` integer, required: Amount of time tracked in seconds, including overtime
      - `overtime_tracked` integer: Amount of overtime in seconds
      - `pay_rate` string, required: The pay rate for this entry
      - `overtime_pay_rate` string: The calculated overtime pay rate for this entry (regular_pay_rate * overtime_multiplier). The overtime_multiplier is defined in the organization overtime policy
      - `overtime_details` OvertimeDetail[], required: Per-policy-type overtime breakdown (may be empty even when overtime_tracked is non-zero)
        - `policy_type` string, required: Overtime policy type this breakdown is attributed to: weekly or daily
        - `overtime` integer, required: Amount of overtime in seconds for this policy type
        - `overtime_pay_rate` string, required: The pay rate for this policy type's overtime. Can be null if no rate was recorded
        - `overtime_policy_id` integer, required: The overtime policy this breakdown is attributed to
        - `amount` string, required: The paid amount for this policy type's overtime, including the invoice discount and tax. Null for an older payment that is not from an invoice
      - `amount` string, required: The amount paid for this entry
      - `currency` string, required: The currency for the pay rate and amount
      - `payment_type` string, required: The type of payment detail entry
      - `payment_complete` boolean: Is this detail paid

## Other responses

- `400`: Invalid parameters
- `401`: Unauthorized
- `403`: API access is only for organizations on an active plan
- `404`: Could not find record
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api.md) - [All operations](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/revisions/c6b90e4e4bdc?raw)