> ## Documentation Index > Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt > Use this file to discover all available pages before exploring further. # List org records > List records across every custom table in the org. Primarily used to browse archived records org-wide. Pass `status=ARCHIVED` for the archive view. ## OpenAPI ````yaml https://api.useinvent.com/openapi.json get /orgs/{org_id}/records openapi: 3.1.0 info: version: 1.0.0 title: Invent API servers: - url: https://api.useinvent.com security: - bearerAuth: [] paths: /orgs/{org_id}/records: get: tags: - Orgs Records summary: List org records description: >- List records across every custom table in the org. Primarily used to browse archived records org-wide. Pass `status=ARCHIVED` for the archive view. parameters: - schema: type: string required: true description: The ID of the org name: org_id in: path - schema: $ref: '#/components/schemas/TableStatusSchema' required: false description: >- Filter by visibility. `ACTIVE` excludes archived (default), `ARCHIVED` returns only archived, `ALL` returns both. name: status in: query - schema: type: string maxLength: 256 description: Search records by display-field value. required: false description: Search records by display-field value. name: search in: query - schema: type: number required: false description: Page number name: page in: query - schema: type: number required: false description: Number of items to take name: take in: query - schema: type: string required: false description: Next page token (Only used on special endpoints) name: next in: query responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TableRecordSchema' components: schemas: TableStatusSchema: type: string enum: - ACTIVE - ARCHIVED - ALL description: >- Filter by visibility. `ACTIVE` excludes archived (default), `ARCHIVED` returns only archived, `ALL` returns both. TableRecordSchema: type: object properties: id: type: string table_id: type: string icon: anyOf: - $ref: '#/components/schemas/PickerIconEmojiSchema' - type: string maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$ description: >- The name of a curated icon a user can pick for a table, view, field, or other entity oneOf: - $ref: '#/components/schemas/PickerIconNameSchema' - type: 'null' description: The picked icon. Null falls back to the table icon. archived: type: boolean description: Whether the record is archived. position: type: - string - 'null' description: The position of the record in the view. updated_at: type: - string - 'null' format: date-time description: >- Last modification time. Total-orders concurrent updates so caches can keep the newest copy. values: type: array items: $ref: '#/components/schemas/TableRecordValueSchema' description: The values of the record. required: - id - table_id - icon - archived - position - updated_at - values PickerIconEmojiSchema: type: string format: emoji description: >- The emoji of a curated icon a user can pick for a table, view, field, or other entity PickerIconNameSchema: type: string enum: - TableCellsIcon - DatabaseIcon - DocumentTextIcon - DocumentChartBarIcon - ClipboardDocumentListIcon - ClipboardDocumentCheckIcon - FolderIcon - ArchiveBoxIcon - InboxIcon - BookOpenIcon - BookmarkIcon - NewspaperIcon - RectangleStackIcon - PencilSquareIcon - UserIcon - UsersIcon - UserGroupIcon - UserPlusIcon - IdentificationIcon - FaceSmileIcon - HandThumbUpIcon - HeartIcon - StarIcon - CheckBadgeIcon - TrophyIcon - CrownIcon - ChatBubbleLeftIcon - ChatBubbleLeftRightIcon - EnvelopeIcon - EnvelopeOpenIcon - PhoneIcon - DevicePhoneMobileIcon - MegaphoneIcon - BellIcon - PaperAirplaneIcon - AtSymbolIcon - RssIcon - LifebuoyIcon - ShoppingCartIcon - ShoppingBagIcon - BuildingStorefrontIcon - CreditCardIcon - BanknotesIcon - CurrencyDollarIcon - CurrencyEuroIcon - ReceiptPercentIcon - WalletIcon - CoinsIcon - GiftIcon - TagIcon - TicketIcon - ScaleIcon - TruckIcon - CubeIcon - CalendarIcon - CalendarDaysIcon - CalendarDateRangeIcon - ClockIcon - FlagIcon - CheckCircleIcon - ListBulletIcon - QueueListIcon - FunnelIcon - ChartBarIcon - ChartPieIcon - PresentationChartLineIcon - ArrowTrendingUpIcon - BriefcaseIcon - WrenchScrewdriverIcon - Cog6ToothIcon - KeyIcon - LockClosedIcon - ShieldCheckIcon - BoltIcon - LightBulbIcon - BeakerIcon - BugAntIcon - CpuChipIcon - CodeBracketIcon - CommandLineIcon - ServerIcon - LinkIcon - HomeIcon - HomeModernIcon - BuildingOfficeIcon - BuildingOffice2Icon - BuildingLibraryIcon - MapPinIcon - MapIcon - GlobeAltIcon - GlobeAmericasIcon - RocketLaunchIcon - PlaneIcon - CarIcon - SunIcon - MoonIcon - FireIcon - SparklesIcon - CakeIcon - AcademicCapIcon - ScissorsIcon - SwatchIcon - PaintBrushIcon - CoffeeIcon - UtensilsIcon - LeafIcon - DumbbellIcon - HeartPulseIcon - PawPrintIcon - StethoscopeIcon - CameraIcon - PhotoIcon - FilmIcon - VideoCameraIcon - MicrophoneIcon - MusicalNoteIcon - SpeakerWaveIcon - PlayCircleIcon - TvIcon - RadioIcon - PuzzlePieceIcon - GamepadIcon description: >- The name of a curated icon a user can pick for a table, view, field, or other entity TableRecordValueSchema: oneOf: - $ref: '#/components/schemas/TableRecordValueStringSchema' - $ref: '#/components/schemas/TableRecordValueNumberSchema' - $ref: '#/components/schemas/TableRecordValueBooleanSchema' - $ref: '#/components/schemas/TableRecordValueDateSchema' - $ref: '#/components/schemas/TableRecordValueDatetimeSchema' - $ref: '#/components/schemas/TableRecordValueEnumSchema' - $ref: '#/components/schemas/TableRecordValueFileSchema' - $ref: '#/components/schemas/TableRecordValueRecordSchema' - $ref: '#/components/schemas/TableRecordValueContactSchema' - $ref: '#/components/schemas/TableRecordValueUserSchema' - $ref: '#/components/schemas/TableRecordValueChatSchema' - $ref: '#/components/schemas/TableRecordValueSegmentSchema' - $ref: '#/components/schemas/TableRecordValueAssistantSchema' discriminator: propertyName: type mapping: string: $ref: '#/components/schemas/TableRecordValueStringSchema' number: $ref: '#/components/schemas/TableRecordValueNumberSchema' boolean: $ref: '#/components/schemas/TableRecordValueBooleanSchema' date: $ref: '#/components/schemas/TableRecordValueDateSchema' datetime: $ref: '#/components/schemas/TableRecordValueDatetimeSchema' enum: $ref: '#/components/schemas/TableRecordValueEnumSchema' file: $ref: '#/components/schemas/TableRecordValueFileSchema' record: $ref: '#/components/schemas/TableRecordValueRecordSchema' contact: $ref: '#/components/schemas/TableRecordValueContactSchema' user: $ref: '#/components/schemas/TableRecordValueUserSchema' chat: $ref: '#/components/schemas/TableRecordValueChatSchema' segment: $ref: '#/components/schemas/TableRecordValueSegmentSchema' assistant: $ref: '#/components/schemas/TableRecordValueAssistantSchema' TableRecordValueStringSchema: type: object properties: id: type: string key: type: string type: type: string enum: - string value: type: string maxLength: 50000 required: - id - key - type - value TableRecordValueNumberSchema: type: object properties: id: type: string key: type: string type: type: string enum: - number value: type: number required: - id - key - type - value TableRecordValueBooleanSchema: type: object properties: id: type: string key: type: string type: type: string enum: - boolean value: type: boolean required: - id - key - type - value TableRecordValueDateSchema: type: object properties: id: type: string key: type: string type: type: string enum: - date value: type: - string - 'null' format: date-time required: - id - key - type - value TableRecordValueDatetimeSchema: type: object properties: id: type: string key: type: string type: type: string enum: - datetime value: type: - string - 'null' format: date-time required: - id - key - type - value TableRecordValueEnumSchema: type: object properties: id: type: string key: type: string type: type: string enum: - enum value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 required: - id - key - type - value TableRecordValueFileSchema: type: object properties: id: type: string key: type: string type: type: string enum: - file value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/FileSchema' - type: array items: $ref: '#/components/schemas/FileSchema' required: - id - key - type - value TableRecordValueRecordSchema: type: object properties: id: type: string key: type: string type: type: string enum: - record value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/TableRecordLimitedSchema' - type: array items: $ref: '#/components/schemas/TableRecordLimitedSchema' required: - id - key - type - value TableRecordValueContactSchema: type: object properties: id: type: string key: type: string type: type: string enum: - contact value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/ContactSchema' - type: array items: $ref: '#/components/schemas/ContactSchema' required: - id - key - type - value TableRecordValueUserSchema: type: object properties: id: type: string key: type: string type: type: string enum: - user value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - allOf: - $ref: '#/components/schemas/UserLimitedSchema' - description: Schema for a limited user - type: array items: allOf: - $ref: '#/components/schemas/UserLimitedSchema' - description: Schema for a limited user required: - id - key - type - value TableRecordValueChatSchema: type: object properties: id: type: string key: type: string type: type: string enum: - chat value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/ChatLimitedSchema' - type: array items: $ref: '#/components/schemas/ChatLimitedSchema' required: - id - key - type - value TableRecordValueSegmentSchema: type: object properties: id: type: string key: type: string type: type: string enum: - segment value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/SegmentLimitedSchema' - type: array items: $ref: '#/components/schemas/SegmentLimitedSchema' required: - id - key - type - value TableRecordValueAssistantSchema: type: object properties: id: type: string key: type: string type: type: string enum: - assistant value: anyOf: - type: string maxLength: 2048 - type: array items: type: string maxLength: 2048 display: anyOf: - $ref: '#/components/schemas/AssistantLimitedSchema' - type: array items: $ref: '#/components/schemas/AssistantLimitedSchema' required: - id - key - type - value FileSchema: type: object properties: id: type: string description: Unique identifier for the file file_path: type: string maxLength: 2048 description: Path to the file in the storage system file_filename: type: string maxLength: 255 description: Name of the file example: document.pdf file_size: type: number description: Size of the file in bytes example: 1024 file_mimetype: type: string maxLength: 255 description: MIME type of the file example: application/pdf file_url: type: string maxLength: 2048 description: URL to access the file created_at: type: - string - 'null' format: date-time description: Timestamp when the file was created required: - id - file_path - file_filename - file_size - file_mimetype - file_url - created_at description: Detailed information about a file TableRecordLimitedSchema: type: object properties: id: type: string table_id: type: string display: oneOf: - $ref: '#/components/schemas/TableRecordValueSchema' - type: 'null' required: - id - table_id - display description: >- Compact reference to a record from another table, used when one record points at another via a `record`-typed field. ContactSchema: type: object properties: id: type: string name: type: - string - 'null' blocked: type: boolean blocked_at: type: string format: date-time unsubscribed: type: boolean unsubscribed_at: type: string format: date-time unsubscribe_reason: type: string unsubscribe_feedback: type: string ai_replies: type: boolean ai_replies_at: type: string format: date-time is_admin: type: boolean channels: type: array items: $ref: '#/components/schemas/ContactChannelSchema' segments: type: array items: $ref: '#/components/schemas/SegmentLimitedSchema' properties: type: object additionalProperties: {} created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - blocked - unsubscribed - ai_replies - is_admin - channels - segments - properties - created_at - updated_at description: Schema for the contact UserLimitedSchema: type: object properties: id: type: string name: type: - string - 'null' email: type: string format: email avatar: type: - string - 'null' seen_at: type: - string - 'null' format: date-time required: - id - name - email - avatar - seen_at description: The assigned user for the conversation ChatLimitedSchema: type: object properties: id: type: string title: type: - string - 'null' status: type: string enum: - RUNNING - COMPLETED - FAILED - CANCELED state: $ref: '#/components/schemas/ChatLimitedStateSchema' created_at: type: - string - 'null' format: date-time required: - id - title - status - created_at description: >- Compact chat reference for embedding in other resources (table value display, ref cells, etc.). Carries the minimum the FE needs to render a chat chip: title, status indicator, state subset (ai_enabled, muted, follow-up, unread), and created date. SegmentLimitedSchema: type: object properties: id: type: string name: type: string color: $ref: '#/components/schemas/ColorNameSchema' contacts_count: type: number created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - color - contacts_count - created_at - updated_at description: Schema for the segment AssistantLimitedSchema: type: object properties: id: type: string name: type: string avatar_url: type: - string - 'null' deleted: type: boolean created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - id - name - avatar_url - deleted - created_at - updated_at description: >- Compact assistant reference for embedding in other resources (table value display, ref cells, etc.). `deleted` lets the FE render soft-deleted assistants as non-clickable while still showing the name and avatar. ContactChannelSchema: type: object properties: id: type: string type: $ref: '#/components/schemas/ConnectionIntegrationIdSchema' user_id: type: string description: >- The unique identifier for the contact channel, e.g Phone Number or User ID avatar: type: - string - 'null' description: The avatar for the contact channel, e.g X Avatar URL name: type: - string - 'null' description: The name for the contact channel, e.g Full Name username: type: - string - 'null' description: The username for the contact channel, e.g Username email: type: - string - 'null' description: The email for the contact channel, e.g Email phone: type: - string - 'null' description: The phone number for the contact channel, e.g Phone Number country: type: - string - 'null' description: >- The country code associated with the contact channel, e.g US for United States agent: type: - string - 'null' description: The user agent associated with the contact channel ip: type: - string - 'null' description: The IP address associated with the contact channel language: type: - string - 'null' description: >- The language code associated with the contact channel, e.g en for English link: type: string description: >- A link to the contact channel, e.g a link to the social media profile platform_data: $ref: '#/components/schemas/ContactChannelPlatformDataSchema' created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - type - user_id - avatar - name - username - email - phone - country - agent - ip - language - platform_data - created_at - updated_at description: Schema for the contact channel ChatLimitedStateSchema: type: object properties: state: $ref: '#/components/schemas/ChatStateStatusSchema' ai_enabled: type: boolean admin_unseen_count: type: number muted_until: type: - string - 'null' format: date-time follow_up_at: type: - string - 'null' format: date-time required: - state - ai_enabled - admin_unseen_count - muted_until - follow_up_at ColorNameSchema: type: string enum: - red - orange - amber - yellow - lime - green - teal - cyan - sky - blue - indigo - violet - purple - fuchsia - pink - rose - neutral description: The name of the color to use in the UI ConnectionIntegrationIdSchema: type: string enum: - internal - org - custom - whatsapp_bot - messenger_bot - instagram_dm - tiktok_dm - telegram_bot - gmail - slack_bot - twilio - telnyx - email description: ID of the connection integration ContactChannelPlatformDataSchema: type: object properties: {} description: Schema for the platform-specific data of a contact channel ChatStateStatusSchema: type: string enum: - OPEN - SNOOZED - CLOSED description: The state status of the chat securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Bearer token authentication using your API key ````