openapi: 3.2.0
info:
  description: Rollee Company API allows to use our services with a REST API
  title: Company Companies API
  contact: {}
  version: '0.5'
servers:
- url: https://api.getrollee.com/api/company/v0.5
tags:
- name: Companies
paths:
  /companies:
    get:
      description: Retrieve information about all companies associated with a specific person
      tags:
      - Companies
      summary: List all companies
      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/v5.GetCompaniesResponse'
        '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: getCompanies
      x-operation-id-source: derived
    post:
      description: creates a new company that belongs to a specific client
      tags:
      - Companies
      summary: Create a new company
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v5.CreateUserParams'
        description: json object describing extra informations for a company
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v5.UserResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: postCompanies
      x-operation-id-source: derived
  /companies/:id:
    delete:
      description: Deletes a company that belongs to a specific client
      tags:
      - Companies
      summary: Delete an existing company
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '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: deleteCompanies:id
      x-operation-id-source: derived
  /companies/{id}:
    get:
      description: Retrieve information about a specific company
      tags:
      - Companies
      summary: Get company info
      parameters:
      - description: company 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/v5.UserResponse'
        '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: getCompaniesById
      x-operation-id-source: derived
components:
  schemas:
    v5.GetCompaniesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/v5.UserResponse'
        size:
          type: integer
    models.StatusResponse:
      type: object
      properties:
        status:
          description: Status will always be "success"
          type: string
          example: success
    v5.UserResponse:
      type: object
      properties:
        company_accounts_number:
          type: integer
        created_at:
          type: string
        id:
          type: string
        link:
          description: link to connect a company 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 company
          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 company session
          type: string
    models.ServerError:
      type: object
      properties:
        error:
          type: string
    models.Metadata:
      type: object
      additionalProperties: {}
    v5.CreateUserParams:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/models.Metadata'
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