OpenAPISchemas/Keap.json at main · shiftnerd/OpenAPISchemas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
{
  "openapi": "3.1.0",
  "info": {
    "title": "Keap REST API",
    "description": "API for accessing and managing various resources in Keap (formerly Infusionsoft).",
    "termsOfService": "https://keap.com/legal",
    "contact": {
      "name": "Developer Support",
      "url": "https://developer.keap.com/get-support/"
    },
    "version": "1.70.0"
  },
  "servers": [
    {
      "url": "https://api.infusionsoft.com/crm/rest",
      "description": "Production server for Keap REST API."
    }
  ],
  "paths": {
    "/v1/contacts/{contactId}": {
      "get": {
        "tags": ["Contacts"],
        "summary": "Get contact by ID",
        "description": "Retrieve the details of a specific contact by ID.",
        "operationId": "getContactById",
        "parameters": [
          {
            "name": "contactId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contact details retrieved successfully."
          },
          "404": {
            "description": "Contact not found."
          }
        }
      }
    },
    "/v1/notes/{noteId}": {
      "get": {
        "tags": ["Notes"],
        "summary": "Retrieve a note by ID",
        "description": "Fetches a specific note by its ID.",
        "operationId": "getNoteById",
        "parameters": [
          {
            "name": "noteId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Note retrieved successfully."
          },
          "404": {
            "description": "Note not found."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Contact": {
        "type": "object",
        "properties": {
          "given_name": { "type": "string" },
          "family_name": { "type": "string" },
          "preferred_locale": { "type": "string" },
          "owner_id": { "type": "string" },
          "suffix": { "type": "string" },
          "birthday": { "type": "string", "format": "date" },
          "anniversary": { "type": "string", "format": "date" },
          "addresses": {
            "type": "array",
            "items": { "type": "string" }
          },
          "email_addresses": {
            "type": "array",
            "items": { "type": "string" }
          },
          "phone_numbers": {
            "type": "array",
            "items": { "type": "string" }
          },
          "fax_numbers": {
            "type": "array",
            "items": { "type": "string" }
          },
          "job_title": { "type": "string" },
          "custom_fields": {
            "type": "array",
            "items": { "type": "string" }
          }
        }
      },
      "Note": {
        "type": "object",
        "properties": {
          "note": {
            "type": "string",
            "description": "The content of the note."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the note was created."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the note was last updated."
          }
        }
      },
      "CustomFieldOption": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "label": { "type": "string" },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": { "type": "string" },
                "label": { "type": "string" }
              }
            }
          }
        }
      },
      "Throwable": {
        "type": "object",
        "properties": {
          "message": { "type": "string" },
          "cause": {
            "type": "object",
            "properties": {
              "message": { "type": "string" },
              "details": { "type": "string" }
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "message": { "type": "string" },
          "details": { "type": "string" }
        }
      }
    }
  }
}