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

# Read Row

> Read a row from a table

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-DatabaseTableAgent.json post /api/v1/Agents/DatabaseTable/ReadRow
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - DatabaseTableAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/DatabaseTable/ReadRow:
    post:
      tags:
        - DatabaseTable_Agent
      summary: Read Row
      description: |-
        Read a row from a table

        NsApiSlow threshold: 2000 ms.
      operationId: v1DatabaseTableAgent_ReadRow
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest
        description: TableName, Id
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TableRecord'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.DatabaseTableCarriers.ReadRowRequest:
      description: 'ReadRow: Read a row from a table'
      type: object
      properties:
        TableName:
          type: string
        Id:
          format: int32
          type: integer
    SuperOffice.CRM.Services.TableRecord:
      description: "The extra table entity contains meta data for an extra table (not implemented yet)\r\n<para />\r\nCarrier object for TableRecord.\r\nServices for the TableRecord Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDatabaseTableAgent\">DatabaseTable Agent</see>."
      type: object
      properties:
        Values:
          description: >-
            Values for the row, where the first string is the column name (e.g.
            x_number), and the second string is the value formatted as a
            DB-value, e.g. [I:42]
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Read Row](/en/api/reference/restful/rest/tablerecord/read-row.md)
- [How to get (read) a row from a custom object](/en/api/web-services/howto/custom-objects/rest-get-custom-object-row.md)
- [SuperOffice.WebApi.Data.DatabaseTable ReadRowRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.DatabaseTable_ReadRowRequest.md)
- [SuperOffice.WebApi.Agents.DatabaseTableAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DatabaseTableAgent.md)
- [SuperOffice.WebApi.Agents.IDatabaseTableAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDatabaseTableAgent.md)
- [NetServer Architecture Deep Dive](/en/api/overview/netserver.md)
