Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add companies property to Contact schema #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 41 additions & 8 deletions descriptions/2.11/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12692,6 +12692,8 @@ components:
"$ref": "#/components/schemas/contact_notes"
companies:
"$ref": "#/components/schemas/contact_companies"
description: "An object containing companies meta data about the companies that a contact has, including url for pagination, total_count of companies, and has_more flag. Up to 10 companies will be displayed here."
nullable: true
location:
"$ref": "#/components/schemas/contact_location"
social_profiles:
Expand Down Expand Up @@ -12757,25 +12759,56 @@ components:
description: An object containing companies meta data about the companies that
a contact has. Up to 10 will be displayed here. Use the url to get more.
properties:
type:
type: string
description: Identifies this model as a list of addressable objects
example: "list"
enum:
- list
data:
type: array
description: An array of addressable objects representing companies
items:
type: object
properties:
type:
type: string
description: The type of addressable object (always 'company' for this array)
example: "company"
enum:
- company
id:
type: string
description: The unique identifier of the company
example: "123"
url:
type: string
format: uri
description: URL for this company resource
example: "/companies/123"
required:
- type
- id
- url
url:
type: string
format: uri
description: Url to get more company resources for this contact
description: URL to get more company resources for this contact
example: "/contacts/5ba682d23d7cf92bef87bfd4/companies"
total_count:
type: integer
description: Int representing the total number of companyies attached to
this contact
description: Int representing the total number of companies attached to this contact
example: 100
has_more:
type: boolean
description: Whether there's more Addressable Objects to be viewed. If true,
use the url to view all
description: Whether there are more companies to be viewed. If true, use the url to see all
example: true
required:
- url
- total_count
- has_more
- type
- data
- url
- total_count
- has_more
contact_deleted:
title: Contact Deleted
type: object
Expand Down