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

# List Entities

> Returns a paginated list of Entities on your Platform.



## OpenAPI

````yaml GET /entities
openapi: 3.1.0
info:
  title: Otim Platform API
  version: v0
  description: >-
    API for managing accounts, entities, transfers, counterparties, and IBANs on
    the Otim platform.
servers:
  - url: https://api.otim.com/v0
security:
  - bearerAuth: []
paths:
  /entities:
    get:
      tags: []
      summary: List Entities
      description: Returns a paginated list of Entities on your Platform.
      operationId: listEntities
      parameters:
        - name: cursor
          in: query
          schema:
            type: string
          description: Pagination cursor from a previous response.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 100
          description: Number of items to return.
      responses:
        '200':
          description: A paginated list of Entities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntities'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PaginatedEntities:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Entity'
        hasMore:
          type: boolean
        nextCursor:
          type: string
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: A machine-readable error code.
        details:
          type: object
          nullable: true
          description: Additional context about the error.
    Entity:
      type: object
      properties:
        id:
          type: string
          example: ent_01JA1B2C3D4E5F6G7H8J9K0L
        email:
          type: string
          format: email
          example: alice@example.com
        type:
          type: string
          enum:
            - individual
            - business
          example: individual
        status:
          type: string
          enum:
            - active
            - inactive
          example: active
        kycStatus:
          type: string
          enum:
            - not_started
            - pending
            - incomplete
            - under_review
            - approved
            - rejected
          example: approved
        tosStatus:
          type: string
          enum:
            - not_started
            - pending
            - approved
          example: approved
        kycLink:
          type: string
          nullable: true
          description: Link for the Entity to complete identity verification.
          example: https://verify.otim.com/kyc/abc123
        tosLink:
          type: string
          nullable: true
          description: Link for the Entity to accept terms of service.
          example: https://verify.otim.com/tos/abc123
        createdAt:
          type: string
          format: date-time
          example: '2025-01-15T12:00:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key prefixed with `sk_`.

````