Connecteam Company Policies:v1:UserCustomSchedulingRulePolicies API

openapi: 3.2.0
info:
  title: Connecteam API documentation Company…
  version: v1
servers:
- url: https://api.connecteam.com/
tags:
- name: Company Policies:v1:UserCustomSchedulingRulePolicies
paths:
  /company-policies/v1/users/{userId}/scheduling-rule-policies:
    get:
      tags:
      - Company Policies:v1:UserCustomSchedulingRulePolicies
      summary: Get user scheduling rule policies
      description: Retrieve the scheduling rule policies assigned to a user, including employee-profile custom rules
      operationId: get_user_scheduling_rule_policies_company_policies_v1_users__userId__scheduling_rule_policies_get
      security:
      - APIKeyHeader: []
      - OAuth2:
        - company_policies.read
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          title: Userid
          description: The unique identifier of the user
          minimum: 1
          type: integer
        description: The unique identifier of the user
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_SchedulingRulePoliciesResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SchedulingRuleModel:
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/SchedulingRuleType'
          description: The type of scheduling rule
        value:
          type: number
          title: Value
          description: The value for the scheduling rule (e.g., hours or number of shifts)
        preventClaim:
          type: boolean
          title: Preventclaim
          description: Whether to prevent shift claims that would violate this rule
          default: true
        applyToSpecificSchedulerId:
          type: integer
          title: Applytospecificschedulerid
          description: If set, this rule only applies to the specified scheduler
        applyToSpecificShifts:
          type: object
          title: Applytospecificshifts
          description: 'Advanced filter to limit which shifts this rule applies to. Structure: {op: ''and''|''or'', filters: [...]}'
      type: object
      required:
      - type
      - value
      title: SchedulingRuleModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SchedulingRulePoliciesResponse:
      properties:
        schedulingRulePolicies:
          items:
            $ref: '#/components/schemas/SchedulingRulePolicyResponse'
          type: array
          title: Schedulingrulepolicies
          description: List of scheduling rule policies
      type: object
      required:
      - schedulingRulePolicies
      title: SchedulingRulePoliciesResponse
    SchedulingRuleType:
      type: string
      enum:
      - maxHoursPerWeek
      - maxShiftsPerWeek
      - maxHoursPerDay
      - maxShiftsPerDay
      - minHoursBetweenShifts
      - minHoursPerWeek
      - minShiftsPerWeek
      title: SchedulingRuleType
      description: An enumeration.
    APIResponse_SchedulingRulePoliciesResponse_:
      properties:
        requestId:
          type: string
          title: Requestid
        data:
          $ref: '#/components/schemas/SchedulingRulePoliciesResponse'
      type: object
      required:
      - data
      title: APIResponse[SchedulingRulePoliciesResponse]
    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
    SchedulingRulePolicyResponse:
      properties:
        id:
          type: integer
          title: Id
          description: The unique identifier of the scheduling rule policy
        name:
          type: string
          title: Name
          description: The name of the scheduling rule policy. Null for a user's custom policy, which is unnamed
        isEnabled:
          type: boolean
          title: Isenabled
          description: Whether the policy is enabled
        isDefaultForNewUsers:
          type: boolean
          title: Isdefaultfornewusers
          description: Whether this policy is automatically assigned to new users
        isCustomPolicy:
          type: boolean
          title: Iscustompolicy
          description: Whether this is a custom policy (custom policies are user-specific)
        rules:
          items:
            $ref: '#/components/schemas/SchedulingRuleModel'
          type: array
          title: Rules
          description: The list of scheduling rules in this policy
      type: object
      required:
      - id
      - name
      - isEnabled
      - isDefaultForNewUsers
      - isCustomPolicy
      - rules
      title: SchedulingRulePolicyResponse
  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)