Connecteam Company Policies:v1:PayRuleAssignment API

openapi: 3.2.0
info:
  title: Connecteam API documentation Company…
  version: v1
servers:
- url: https://api.connecteam.com/
tags:
- name: Company Policies:v1:PayRuleAssignment
paths:
  /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments:
    put:
      tags:
      - Company Policies:v1:PayRuleAssignment
      summary: Assign user to pay rule policy
      description: Assign user to specified pay rule policy. If the provided effective date is earlier than the currently assigned policy's effective date, the existing policy assignment will be replaced and removed.
      operationId: assign_user_to_policy_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments_put
      security:
      - APIKeyHeader: []
      - OAuth2:
        - company_policies.write
      parameters:
      - name: payRulePolicyId
        in: path
        required: true
        schema:
          title: Payrulepolicyid
          description: The unique identifier of the pay rule policy to assign
          type: integer
        description: The unique identifier of the pay rule policy to assign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              title: Request
              allOf:
              - $ref: '#/components/schemas/PayRuleAssignmentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_PayRuleAssignmentResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Company Policies:v1:PayRuleAssignment
      summary: List pay rule policy assignments
      description: Retrieve all assignments for a specific pay rule policy that are in effect on the given date
      operationId: list_assignments_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments_get
      security:
      - APIKeyHeader: []
      - OAuth2:
        - company_policies.read
      parameters:
      - name: payRulePolicyId
        in: path
        required: true
        schema:
          title: Payrulepolicyid
          description: The unique identifier of the pay rule policy
          type: integer
        description: The unique identifier of the pay rule policy
      - name: effectiveDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: The date to list assignments for, specified in ISO 8601 format (e.g., 2025-01-25). Defaults to today when omitted
          title: Effectivedate
        description: The date to list assignments for, specified in ISO 8601 format (e.g., 2025-01-25). Defaults to today when omitted
      - name: userIds
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: integer
              minimum: 1
          - type: 'null'
          description: When set, return only these users' assignments on the policy. Repeat the parameter per user
          title: Userids
        description: When set, return only these users' assignments on the policy. Repeat the parameter per user
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: The maximum number of results to display per page
          default: 100
          title: Limit
        description: The maximum number of results to display per page
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
          default: 0
          title: Offset
        description: The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBaseResponseV2_PayRuleAssignmentListData_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments/{assignmentId}:
    delete:
      tags:
      - Company Policies:v1:PayRuleAssignment
      summary: Remove pay rule policy assignment
      description: Remove a specific assignment from a pay rule policy
      operationId: delete_assignment_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments__assignmentId__delete
      security:
      - APIKeyHeader: []
      - OAuth2:
        - company_policies.delete
      parameters:
      - name: assignmentId
        in: path
        required: true
        schema:
          type: integer
          description: The unique identifier of the assignment to remove
          title: Assignmentid
        description: The unique identifier of the assignment to remove
      - name: payRulePolicyId
        in: path
        required: true
        schema:
          title: Payrulepolicyid
          description: The unique identifier of the pay rule policy
          type: integer
        description: The unique identifier of the pay rule policy
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseV2_BaseResponseV2_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PayRuleAssignmentListItem:
      properties:
        assignmentId:
          type: integer
          title: Assignmentid
          description: The unique identifier of the assignment record
        userId:
          type: integer
          title: Userid
          description: The unique identifier of the assigned user
        effectiveDate:
          type: string
          format: date
          title: Effectivedate
          description: The date the assignment takes effect (ISO 8601)
      type: object
      required:
      - assignmentId
      - userId
      - effectiveDate
      title: PayRuleAssignmentListItem
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PaginatedBaseResponseV2_PayRuleAssignmentListData_:
      properties:
        requestId:
          type: string
          title: Requestid
        data:
          $ref: '#/components/schemas/PayRuleAssignmentListData'
        paging:
          $ref: '#/components/schemas/PagingResponseModelV2'
      type: object
      required:
      - data
      - paging
      title: PaginatedBaseResponseV2[PayRuleAssignmentListData]
    PayRuleAssignmentListData:
      properties:
        assignments:
          items:
            $ref: '#/components/schemas/PayRuleAssignmentListItem'
          type: array
          title: Assignments
          description: List of assignments for the policy
      type: object
      required:
      - assignments
      title: PayRuleAssignmentListData
    PayRuleAssignmentRequest:
      properties:
        userId:
          type: integer
          title: Userid
          description: The unique identifier of the user
        effectiveDate:
          type: string
          format: date
          title: Effectivedate
          description: The date for the policy to take effect, specified in ISO 8601 format (e.g., 2025-01-25)
      type: object
      required:
      - userId
      - effectiveDate
      title: PayRuleAssignmentRequest
    BaseResponseV2:
      properties: {}
      type: object
      title: BaseResponseV2
      description: V2 base response model
    PayRuleAssignmentResponse:
      properties:
        assignmentId:
          type: integer
          title: Assignmentid
          description: The unique identifier of the assignment record
      type: object
      required:
      - assignmentId
      title: PayRuleAssignmentResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    APIResponseV2_BaseResponseV2_:
      properties:
        requestId:
          type: string
          title: Requestid
        data:
          $ref: '#/components/schemas/BaseResponseV2'
      type: object
      required:
      - data
      title: APIResponseV2[BaseResponseV2]
    APIResponse_PayRuleAssignmentResponse_:
      properties:
        requestId:
          type: string
          title: Requestid
        data:
          $ref: '#/components/schemas/PayRuleAssignmentResponse'
      type: object
      required:
      - data
      title: APIResponse[PayRuleAssignmentResponse]
    PagingResponseModelV2:
      properties:
        offset:
          type: integer
          minimum: 0.0
          title: Offset
          description: The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
          description: Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it.
      type: object
      required:
      - offset
      title: PagingResponseModelV2
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: The Api key of the company given by Connecteam
      in: header
      name: X-API-KEY
    OAuth2:
      type: oauth2
      description: OAuth2 Bearer token
      flows:
        clientCredentials:
          scopes:
            account_information.read: account information - read
            account_information.write: account information - write
            account_information.delete: account information - delete
            company_policies.read: company policies - read
            company_policies.write: company policies - write
            company_policies.delete: company policies - delete
            company_insights.read: company insights - read
            users.read: users - read
            users.write: users - write
            users.delete: users - delete
            assets.read: assets - read
            assets.write: assets - write
            assets.delete: assets - delete
            sales_data.read: sales data - read
            sales_data.write: sales data - write
            sales_data.delete: sales data - delete
            attachments.read: attachments - read
            attachments.write: attachments - write
            attachments.delete: attachments - delete
            quick_tasks.read: quick tasks - read
            quick_tasks.write: quick tasks - write
            quick_tasks.delete: quick tasks - delete
            publishers.read: publishers - read
            publishers.write: publishers - write
            publishers.delete: publishers - delete
            chat.read: chat - read
            chat.write: chat - write
            chat.delete: chat - delete
            jobs.read: jobs - read
            jobs.write: jobs - write
            jobs.delete: jobs - delete
            schedule.read: schedule - read
            schedule.write: schedule - write
            schedule.delete: schedule - delete
            daily_note.read: daily note - read
            daily_note.write: daily note - write
            daily_note.delete: daily note - delete
            time_clock.read: time clock - read
            time_clock.write: time clock - write
            time_clock.delete: time clock - delete
            nfc.read: nfc - read
            nfc.write: nfc - write
            nfc.delete: nfc - delete
            time_off.read: time off - read
            time_off.write: time off - write
            time_off.delete: time off - delete
            pay_rates.read: pay rates - read
            pay_rates.write: pay rates - write
            pay_rates.delete: pay rates - delete
            forms.read: forms - read
            forms.write: forms - write
            forms.delete: forms - delete
            onboarding.read: onboarding - read
            onboarding.write: onboarding - write
            onboarding.delete: onboarding - delete
            settings.read: settings - read
            settings.write: settings - write
            settings.delete: settings - delete
            company_checklist.read: company checklist - read
            company_checklist.write: company checklist - write
            recognitions.read: recognitions - read
            celebrations.read: celebrations - read
            documents.read: documents - read
            documents.write: documents - write
          tokenUrl: /oauth/v1/token
    HTTPBasic:
      type: http
      description: Use client_id as Username and client_secret as Password
      scheme: basic
x-provenance:
  method: harvested
  publisher: Connecteam
  source: https://api.connecteam.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)