openapi: 3.2.0
info:
  title: Rollee Users API
  contact: {}
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: rollee-company-api-openapi.yml, rollee-user-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getrollee.com/api/company/v0.5
- url: https://api.getrollee.com/api/v0.5
tags:
- name: Users
paths:
  /users/{id}:
    get:
      description: Retrieve information about a user
      tags:
      - Users
      summary: Get user
      parameters:
      - description: user id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/go-rl_cmd_api_company_v05_models.ResponseGetUsers'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getUsersById
      x-operation-id-source: derived
    put:
      description: Updates user's metadata
      tags:
      - Users
      summary: Update user
      parameters:
      - description: user id
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.BodyWithMetadata'
        description: Extra information for the user
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v5.UpdateUserResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putUsersById
      x-operation-id-source: derived
    delete:
      description: Delete a User and its associated Accounts
      tags:
      - Users
      summary: Delete user
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: user id
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.DeleteUserResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: deleteUsersById
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/company/v0.5
  /users:
    get:
      description: Get informations for all users
      tags:
      - Users
      summary: Get Users
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/go-rl_cmd_api_v05_models.ResponseGetUsers'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getUsers
      x-operation-id-source: derived
    post:
      description: Create a user with optional metadata
      tags:
      - Users
      summary: Create User
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.CreateUserParams'
        description: user parameters
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/go-rl_cmd_api_v05_models.User'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: postUsers
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /users/{id}/performance_index:
    get:
      description: Get performance index for the user. Available for gig economy platforms only.
      tags:
      - Users
      summary: Get performance index
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: user id
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/models.PerformanceIndices'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getUsersByIdPerformanceIndex
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /users/{id}/sessions/new:
    post:
      description: Create a session for a user (intended for users created with the API v0.3)
      tags:
      - Users
      summary: Create a session for an user
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: user id
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.UserSessionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: postUsersByIdSessionsNew
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
components:
  schemas:
    go-rl_cmd_api_company_v05_models.ResponseGetUsers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/go-rl_cmd_api_company_v05_models.User'
        next_page_link:
          type: string
        size_data:
          type: integer
    models.BodyWithMetadata:
      type: object
      properties:
        metadata:
          description: any valid json object
          allOf:
          - $ref: '#/components/schemas/models.Metadata'
    go-rl_cmd_api_company_v05_models.User:
      type: object
      properties:
        accounts_number:
          type: integer
        created_at:
          type: string
        id:
          type: string
        metadata:
          $ref: '#/components/schemas/models.Metadata'
    models.ServerError:
      type: object
      properties:
        error:
          type: string
    models.Metadata:
      type: object
      additionalProperties: {}
    v5.UpdateUserResponse:
      type: object
      properties:
        accounts_number:
          type: integer
        created_at:
          type: string
        id:
          type: string
        metadata:
          $ref: '#/components/schemas/models.Metadata'
    models.DeleteUserResponse:
      type: object
      properties:
        status:
          type: string
        user_id:
          type: string
    models.UserSessionResponse:
      type: object
      properties:
        link:
          type: string
        session:
          type: string
        session_expires_at:
          type: string
    models.PerformanceIndices:
      type: object
      properties:
        distance_based_efficiency:
          type: number
        earning_efficiency:
          type: number
        efficiency_index:
          type: number
        income_amount:
          type: number
        income_index:
          type: number
        income_level_score:
          type: number
        income_stability:
          type: number
        income_volatility_score:
          type: number
        order_execution_efficiency_score:
          type: number
        order_strategy_score:
          type: number
        rollee_performance_index:
          type: number
        special_income_component_score:
          type: number
        special_income_components:
          type: number
        special_working_hours:
          type: number
        sustainability_index:
          type: number
        time_based_efficiency:
          type: number
        time_usage_efficiency_score:
          type: number
        working_pattern_stability_score:
          type: number
        working_schedule_stability:
          type: number
        working_time_patterns:
          type: number
        working_trend_score:
          type: number
        workload_score:
          type: number
    go-rl_cmd_api_v05_models.User:
      type: object
      properties:
        accounts_number:
          type: integer
        connected_accounts_count:
          type: integer
        created_at:
          type: string
        id:
          type: string
        link:
          description: link for a user to connect his account with rollee
          type: string
        metadata:
          description: json object containing extra informations
          allOf:
          - $ref: '#/components/schemas/models.Metadata'
        session:
          description: session token associated to the user
          type: string
        session_expired:
          description: is this session expired (default expiration is 30 minutes but it can be changed per client request)
          type: boolean
        session_expires_at:
          description: expiration time of the user session
          type: string
    models.CreateUserParams:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/models.Metadata'
    go-rl_cmd_api_v05_models.ResponseGetUsers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/go-rl_cmd_api_v05_models.User'
        next_page_link:
          type: string
        size_data:
          type: integer
x-refined-from:
- rollee-company-api-openapi.yml
- rollee-user-api-openapi.yml
x-provenance:
  method: searched
  source: https://developers.getrollee.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.getrollee.com/reference/delete_companies-id.md
  - https://developers.getrollee.com/reference/get_companies-id-company-accounts.md
  - https://developers.getrollee.com/reference/get_companies-id.md
  - https://developers.getrollee.com/reference/get_companies.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-absences.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-activity.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-banking-info.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-documents.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-employees.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-employment.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-income.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-performance.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-profiles.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-trips.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-vehicles.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-wallet.md
  - https://developers.getrollee.com/reference/get_company-accounts-id.md
  - https://developers.getrollee.com/reference/get_token-refresh.md
  - https://developers.getrollee.com/reference/get_users-id.md
  - https://developers.getrollee.com/reference/get_webhooks-1.md
  - https://developers.getrollee.com/reference/post_companies.md
  - https://developers.getrollee.com/reference/post_company-accounts-id-reconnect.md
  - https://developers.getrollee.com/reference/post_sessions-session-refresh.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-accounts.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-endpoints.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-multi-endpoints.md
  - https://developers.getrollee.com/reference/put_users-id.md
  merge:
    pages: 27
    deduped: 49
    conflicts_kept_first: 0