Skip to content

Commit 32f8e6b

Browse files
Adding Open API spec for Team endpoint (#4)
1 parent 3d2f0f0 commit 32f8e6b

1 file changed

Lines changed: 106 additions & 1 deletion

File tree

descriptions/api.intercom.io.yaml

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,70 @@ paths:
573573
application/json:
574574
schema:
575575
"$ref": "#/components/schemas/error"
576+
"/teams":
577+
get:
578+
summary: List all teams
579+
parameters:
580+
- name: Intercom-Version
581+
in: header
582+
schema:
583+
"$ref": "#/components/schemas/intercom_version"
584+
tags:
585+
- Team
586+
operationId: listTeams
587+
description: This will return a list of team objects for the App.
588+
responses:
589+
'200':
590+
description: successful
591+
content:
592+
application/json:
593+
schema:
594+
"$ref": "#/components/schemas/team"
595+
'401':
596+
description: Unauthorized
597+
content:
598+
application/json:
599+
schema:
600+
"$ref": "#/components/schemas/error"
601+
"/teams/{id}":
602+
parameters:
603+
- name: id
604+
in: path
605+
required: true
606+
description: The unique identifier of a given team.
607+
schema:
608+
type: string
609+
get:
610+
summary: Retrieve a team
611+
parameters:
612+
- name: Intercom-Version
613+
in: header
614+
schema:
615+
"$ref": "#/components/schemas/intercom_version"
616+
tags:
617+
- Team
618+
operationId: retrieveTeam
619+
description: You can fetch the details of a single team, containing an array
620+
of admins that belong to this team.
621+
responses:
622+
'200':
623+
description: successful
624+
content:
625+
application/json:
626+
schema:
627+
"$ref": "#/components/schemas/team"
628+
'404':
629+
description: Team not found
630+
content:
631+
application/json:
632+
schema:
633+
"$ref": "#/components/schemas/error"
634+
'401':
635+
description: Unauthorized
636+
content:
637+
application/json:
638+
schema:
639+
"$ref": "#/components/schemas/error"
576640
components:
577641
schemas:
578642
intercom_version:
@@ -1202,7 +1266,7 @@ components:
12021266
nullable: true
12031267
description: The URL where the conversation was started. For Twitter, Email,
12041268
and Bots, this will be blank.
1205-
example:
1269+
example:
12061270
redacted:
12071271
type: boolean
12081272
description: Whether or not the source message has been redacted. Only applicable
@@ -1835,6 +1899,45 @@ components:
18351899
deleted:
18361900
type: boolean
18371901
description: Whether the news item was deleted successfully or not.
1902+
team:
1903+
title: Team
1904+
type: object
1905+
description: Teams are groups of admins in Intercom.
1906+
properties:
1907+
type:
1908+
type: string
1909+
description: value is "team"
1910+
example: team
1911+
id:
1912+
type: string
1913+
description: The id of the team
1914+
example: '814865'
1915+
name:
1916+
type: string
1917+
description: The name of the team
1918+
example: Example Team
1919+
admin_ids:
1920+
type: array
1921+
description: The list of admin id`s that are a part of the team.
1922+
example:
1923+
- 493881
1924+
items:
1925+
type: integer
1926+
teams:
1927+
title: Teams
1928+
type: object
1929+
description: This will return a list of team objects for the App.
1930+
properties:
1931+
type:
1932+
type: string
1933+
description: The type of the object
1934+
enum:
1935+
- team.list
1936+
teams:
1937+
type: array
1938+
description: A list of team objects
1939+
items:
1940+
"$ref": "#/components/schemas/team"
18381941
securitySchemes:
18391942
bearerAuth:
18401943
type: http
@@ -1861,3 +1964,5 @@ tags:
18611964
externalDocs:
18621965
description: News explained
18631966
url: https://www.intercom.com/help/en/articles/6362251-news-explained
1967+
- name: Team
1968+
description: Everything about your Teams

0 commit comments

Comments
 (0)