> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partner-api.tryrima.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List companies

> For listing companies a credential can access.

Results include only credential-authorized companies. Each Company object contains only `id` and `name`.

When supplied, `companyId` and `name` must be nonempty. `limit` is an integer from 1 to 100 (default 50), and `offset` is a nonnegative integer (default 0). Invalid query values return `400 invalid_input`; a `companyId` outside the key's policy returns `403 forbidden`.


## OpenAPI

````yaml openapi.json GET /v1/companies
openapi: 3.1.0
info:
  title: Rima Partner API
  version: 0.0.1
  description: >-
    Use `https://partner-api.tryrima.com` for the Rima Partner API.


    Send requests from your backend with `Authorization: Bearer <key>`. Keep the
    key in a secrets manager and out of email, support requests, and shared
    documents. Keys are scoped to approved operations and companies.


    Responses include `x-request-id`. Include that ID and the request timestamp
    when reporting a failed request; never include the key.
servers:
  - url: https://partner-api.tryrima.com
    description: Rima
security: []
paths:
  /v1/companies:
    get:
      summary: List companies
      parameters:
        - name: companyId
          in: query
          required: false
          description: Optional exact ID filter.
          schema:
            type: string
            minLength: 1
        - name: name
          in: query
          required: false
          description: Optional case-insensitive partial match.
          schema:
            type: string
            minLength: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Authorized companies.
          content:
            application/json:
              schema:
                type: object
                properties:
                  companies:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                        - id
                        - name
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                  - companies
                  - pagination
              examples:
                example:
                  value:
                    companies:
                      - id: company_example
                        name: Example Home Care
                    pagination:
                      limit: 50
                      offset: 0
                      total: 1
        '400':
          $ref: '#/components/responses/InvalidInput'
        '401':
          $ref: '#/components/responses/InvalidApiKey'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    Pagination:
      type: object
      properties:
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
      required:
        - limit
        - offset
        - total
  responses:
    InvalidInput:
      description: >-
        Invalid search, query, or path input. Unsupported external ID systems
        include a message naming the value.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - invalid_input
              message:
                type: string
                description: Names the unsupported externalIdSystems value when applicable.
            required:
              - error
            additionalProperties: false
          example:
            error: invalid_input
    InvalidApiKey:
      description: Missing or invalid partner API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - invalid_api_key
            required:
              - error
            additionalProperties: false
          example:
            error: invalid_api_key
    Forbidden:
      description: Operation or company access is not permitted.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - forbidden
            required:
              - error
            additionalProperties: false
          example:
            error: forbidden
    RateLimited:
      description: Partner API key request allowance is exhausted.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - rate_limited
            required:
              - error
            additionalProperties: false
          example:
            error: rate_limited
    InternalError:
      description: The service could not complete the request.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - internal_error
            required:
              - error
            additionalProperties: false
          example:
            error: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.