> ## 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.

# Get Custom Object

> Returns a single Custom Object row by definition name and primary key.



## OpenAPI

````yaml /openapi/rest/openapi-v3-CustomObject.json get /api/v1/CustomObject/{definitionName}/{id}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - CustomObject
  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/CustomObject/{definitionName}/{id}:
    get:
      tags:
        - CustomObject
      summary: Get Custom Object
      description: Returns a single Custom Object row by definition name and primary key.
      operationId: v1CustomObject_GetCustomObject
      parameters:
        - name: definitionName
          in: path
          description: >-
            Database table name of the Custom Object Definition, e.g.
            'y_equipment'.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: Primary key of the row to fetch.
          required: true
          schema:
            type: integer
            format: int32
        - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomObject'
        '404':
          description: Not Found.
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.CustomObject:
      description: "A single row in a Custom Object table.\r\n<para />\r\nCarrier object for CustomObject.\r\nServices for the CustomObject Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICustomObjectAgent\">CustomObject Agent</see>."
      type: object
      properties:
        DefinitionName:
          description: >-
            Database table name of the Custom Object Definition this row belongs
            to, e.g. 'y_equipment'.
          type: string
        Id:
          format: int32
          description: Primary key of the row.
          type: integer
        Values:
          description: >-
            Column values for this row. Keys are database column names; values
            are formatted with CultureDataFormatter (e.g. '[I:42]' for
            integers).
          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

- [Get Custom Object](/en/api/reference/restful/agent/customobject_agent/get-custom-object.md)
- [Get Custom Objects Metadata](/en/api/reference/restful/agent/customobject_agent/get-custom-objects-metadata.md)
- [Get Custom Object Definition](/en/api/reference/restful/agent/customobject_agent/get-custom-object-definition.md)
- [Get Custom Objects Icons](/en/api/reference/restful/agent/customobject_agent/get-custom-objects-icons.md)
- [SuperOffice.WebApi.Data.CustomObject GetCustomObjectRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_GetCustomObjectRequest.md)