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

# Get custom object (schema)

> Includes properties, stages and associations.



## OpenAPI

````yaml https://api.apyconnect.io/v1/openapi.json get /v1/objects/{key}
openapi: 3.1.0
info:
  title: ApyConnect API
  version: 1.0.0
  description: >-
    ApyConnect public API. OAuth 2.0 authentication (client_credentials grant)
    with opaque Bearer tokens. Wrapped responses ({data, meta} / {object:'list',
    data, pagination, meta}); typed errors with trace_id; cursor pagination;
    snake_case throughout the JSON. Rate limit per Application.


    Best practices: send an `Idempotency-Key` header on writes to make retries
    safe (the same key replays the stored response for 24h; reusing a key with a
    different body returns 409). Use `?expand=contact` (and `expand=company` on
    deals) to embed related resources and save round-trips. Deprecated endpoints
    carry RFC 8594 `Deprecation`/`Sunset` headers. Inspect usage at `/v1/usage`
    and the write audit trail at `/v1/audit-logs`.
  contact:
    name: ApyConnect
    url: https://docs.apyconnect.io
servers:
  - url: https://api.apyconnect.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: Contacts
  - name: Conversations
  - name: Messages
  - name: Channels
  - name: Inboxes
  - name: Campaigns
  - name: Analytics
  - name: Webhooks
  - name: Deals
  - name: Tasks
  - name: Companies
  - name: Tickets
  - name: Custom objects
    description: >-
      Objects each workspace defines (policies, vehicles, properties…) and their
      records. Address an object by its key (e.g. `policies`) or id.
  - name: Notes
  - name: Segments
  - name: Macros
  - name: Settings
  - name: Jobs
  - name: Observability
paths:
  /v1/objects/{key}:
    parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: Object key (e.g. `policies`) or id.
    get:
      tags:
        - Custom objects
      summary: Get custom object (schema)
      description: Includes properties, stages and associations.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomObject'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '401':
          description: authentication_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: permission_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: not_found_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: rate_limit_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    CustomObject:
      type: object
      properties:
        object:
          const: custom_object
        id:
          type: string
        key:
          type: string
        name_singular:
          type: string
        name_plural:
          type: string
        description:
          type:
            - string
            - 'null'
        icon:
          type: string
        color:
          type: string
        primary_property:
          type: string
        number_prefix:
          type:
            - string
            - 'null'
        stages:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
              color:
                type: string
              kind:
                type: string
                enum:
                  - open
                  - done
                  - lost
        properties:
          type: array
          description: Only in GET /v1/objects/{key}.
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
              description:
                type:
                  - string
                  - 'null'
              type:
                type: string
                enum:
                  - text
                  - textarea
                  - number
                  - currency
                  - percent
                  - date
                  - datetime
                  - boolean
                  - select
                  - multiselect
                  - email
                  - phone
                  - url
                  - user
                  - reference
                  - rating
              required:
                type: boolean
              unique:
                type: boolean
              options:
                type: object
                description: choices (select/multiselect), currency, decimals, min, max…
        associations:
          type: array
          description: Only in GET /v1/objects/{key}.
          items:
            type: object
            properties:
              id:
                type: string
              label:
                type:
                  - string
                  - 'null'
              inverse_label:
                type:
                  - string
                  - 'null'
              target_type:
                type: string
                enum:
                  - contact
                  - company
                  - deal
                  - ticket
                  - object
              target_object_key:
                type:
                  - string
                  - 'null'
              cardinality:
                type: string
                enum:
                  - one
                  - many
              required:
                type: boolean
        archived:
          type: boolean
        integration_id:
          type:
            - string
            - 'null'
          description: >-
            Set when a marketplace integration provides the object. Its records,
            stages and managed properties are written by the integration (writes
            return 403 managed_object); you can still edit your own properties,
            links, notes and owner.
        created_at:
          type: string
        updated_at:
          type: string
    Meta:
      type: object
      properties:
        request_id:
          type: string
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - not_found_error
                - conflict_error
                - api_error
            code:
              type: string
            message:
              type: string
            trace_id:
              type: string
            details: {}
          required:
            - type
            - code
            - message
            - trace_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Opaque token issued by /oauth/token.

````

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