-
Notifications
You must be signed in to change notification settings - Fork 3
/
crm.yml
9779 lines (9677 loc) · 326 KB
/
crm.yml
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
version: 10.8.1
title: CRM API
description: "Welcome to the CRM API.\n\nYou can use this API to access all CRM API endpoints.\n\n## Base URL\n\nThe base URL for all API requests is `https://unify.apideck.com`\n\n## Headers\n\nCustom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.\n\n| Name | Type | Required | Description |\n| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |\n| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |\n| x-apideck-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. |\n| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |\n| Authorization | String | Yes | Bearer API KEY |\n\n## Authorization\n\nYou can interact with the API through the authorization methods below.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n## Pagination\n\nAll API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional `cursor` and `limit` parameters.\n\nTo fetch the first page of results, call the list API without a `cursor` parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in `meta.cursors.next`. If `meta.cursors.next` is `null` you're at the end of the list.\n\nIn the REST API you can also use the `links` from the response for added convenience. Simply call the URL in `links.next` to get the next page of results.\n\n### Query Parameters\n\n| Name | Type | Required | Description |\n| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |\n| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |\n| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |\n\n### Response Body\n\n| Name | Type | Description |\n| --------------------- | ------ | ------------------------------------------------------------------ |\n| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |\n| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |\n| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |\n| meta.items_on_page | Number | Number of items returned in the data property of the response |\n| links.previous | String | Link to navigate to the previous page of results through the API |\n| links.current | String | Link to navigate to the current page of results through the API |\n| links.next | String | Link to navigate to the next page of results through the API |\n\n⚠️ `meta.cursors.previous`/`links.previous` is not available for all connectors.\n\n## SDKs and API Clients\n\nWe currently offer a [Node.js](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php), [Python](https://developers.apideck.com/sdks/python) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK.\nNeed another SDK? [Request the SDK of your choice](https://requests.apideck.io/request).\n\n## Debugging\n\nBecause of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag `?raw=true` in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.\n\n## Errors\n\nThe API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.\n\n| Code | Title | Description |\n| ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. |\n| 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. |\n| 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |\n| 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |\n| 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. |\n| 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. |\n| 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. |\n| 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. |\n| 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. |\n| 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. |\n| 429 | Too Many Requests | You sent too many requests in a given amount of time (\"rate limit\"). Try again later |\n| 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. |\n\n### Handling errors\n\nThe Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.\n\n### Error Types\n\n#### RequestValidationError\n\nRequest is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.\n\n#### UnsupportedFiltersError\n\nFilters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.\n\n#### UnsupportedSortFieldError\n\nSort field (`sort[by]`) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.\n\n#### InvalidCursorError\n\nPagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.\n\n#### ConnectorExecutionError\n\nA Unified API request made via one of our downstream connectors returned an unexpected error. The `status_code` returned is proxied through to error response along with their original response via the error detail.\n\n#### UnauthorizedError\n\nWe were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: `Authorization: 'Bearer sk_live_***'`\n\n#### ConnectorCredentialsError\n\nA request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.\n\n#### ConnectorDisabledError\n\nA request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.\n\n#### ConnectorRateLimitError\n\nYou sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.\n\n#### RequestLimitError\n\nYou have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to [email protected] to continue making requests.\n\n#### EntityNotFoundError\n\nYou've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.\n\n#### OAuthCredentialsNotFoundError\n\nWhen adding a connector integration that implements OAuth, both a `client_id` and `client_secret` must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.\n\n#### IntegrationNotFoundError\n\nThe requested connector integration could not be found associated to your `application_id`. Verify your `application_id` is correct, and that this connector has been added and configured for your application.\n\n#### ConnectionNotFoundError\n\nA valid connection could not be found associated to your `application_id`. Something _may_ have interrupted the authorization flow. You may need to start the connector authorization process again.\n\n#### ConnectionSettingsError\n\nThe connector has required settings that were not supplied. Verify `connection.settings` contains all required settings for the connector to be callable.\n\n#### ConnectorNotFoundError\n\nA request was made for an unknown connector. Verify your `service_id` is spelled correctly, and that this connector is enabled for your provided `unified_api`.\n\n#### OAuthRedirectUriError\n\nA request was made either in a connector authorization flow, or attempting to revoke connector access without a valid `redirect_uri`. This is the url the user should be returned to on completion of process.\n\n#### OAuthInvalidStateError\n\nThe state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.\n\n#### OAuthCodeExchangeError\n\nWhen attempting to exchange the authorization code for an `access_token` during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.\n\n#### OAuthConnectorError\n\nIt seems something went wrong on the connector side. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### MappingError\n\nThere was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.\n\n#### ConnectorMappingNotFoundError\n\nIt seems the implementation for this connector is incomplete. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorResponseMappingNotFoundError\n\nWe were unable to retrieve the response mapping for this connector. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationMappingNotFoundError\n\nConnector mapping has not been implemented for the requested operation. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorWorkflowMappingError\n\nThe composite api calls required for this operation have not been mapped entirely. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationUnsupportedError\n\nYou're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.\n\n#### PaginationNotSupportedError\n\nPagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n## API Design\n\n### API Styles and data formats\n\n#### REST API\n\nThe API is organized around [REST](https://restfulapi.net/), providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.\n\n##### Available HTTP methods\n\nThe Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \\_method.\n\n```\nPOST /messages\nGET /messages\nGET /messages/{messageId}\nPATCH /messages/{messageId}\nDELETE /messages/{messageId}\n```\n\nResponse bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.\n\n### Schema\n\nAll API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.\n\n### Meta\n\nMeta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.\n\n### Request IDs\n\nEach API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n### Fixed field types\n\n#### Dates\n\nThe dates returned by the API are all represented in UTC (ISO8601 format).\n\nThis example\_`2019-11-14T00:55:31.820Z`\_is defined by the\_ISO 8601\_standard. The\_T\_in the middle separates the year-month-day portion from the hour-minute-second portion. The\_Z\_on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The\_Z\_is pronounced \"Zulu\" per military/aviation tradition.\n\nThe ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.\n\n#### Prices and Currencies\n\nAll prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).\n\nFor zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.\n\nAll currency codes conform to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).\n\n## Support\n\nIf you have problems or need help with your case, you can always reach out to our Support.\n\n## Static IP\n\nSome of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.\nTo use this feature, the API Vendor will need to whitelist the associated static IP addresses.\nThe provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.\n\n- EU Central 1: **18.197.244.247**, **18.156.9.3**, **3.65.139.215**\n- Other: upcoming\n\n More info about our data security can be found at [https://compliance.apideck.com/](https://compliance.apideck.com/)\n\n"
contact:
email: [email protected]
url: https://developers.apideck.com
x-logo:
url: https://developers.apideck.com/icon.png
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
x-apideck-api: crm
x-apideck-sdk-support: true
externalDocs:
description: Apideck Developer Docs
url: https://developers.apideck.com
servers:
- url: https://unify.apideck.com
description: Production
security:
- apiKey: []
applicationId: []
consumerId: []
tags:
- name: Companies
description: ''
x-apideck-resource-id: companies
x-apideck-model:
$ref: '#/components/schemas/Company'
- name: Opportunities
description: ''
x-apideck-resource-id: opportunities
x-apideck-model:
$ref: '#/components/schemas/Opportunity'
- name: Leads
description: ''
x-apideck-resource-id: leads
x-apideck-model:
$ref: '#/components/schemas/Lead'
- name: Contacts
description: ''
x-apideck-resource-id: contacts
x-apideck-model:
$ref: '#/components/schemas/Contact'
- name: Pipelines
description: ''
x-apideck-resource-id: pipelines
x-apideck-model:
$ref: '#/components/schemas/Pipeline'
- name: Notes
description: ''
x-apideck-resource-id: notes
x-apideck-model:
$ref: '#/components/schemas/Note'
- name: Users
description: ''
x-apideck-resource-id: users
x-apideck-model:
$ref: '#/components/schemas/User'
- name: Activities
description: ''
x-apideck-resource-id: activities
x-apideck-model:
$ref: '#/components/schemas/Activity'
components:
schemas:
ActivitiesFilter:
type: object
x-apideck-schema-id: ActivitiesFilter
example:
updated_since: '2020-09-30T07:43:32.000Z'
properties:
company_id:
type: string
description: Company ID to filter on
example: '1234'
owner_id:
type: string
description: Owner ID to filter on
example: '1234'
contact_id:
type: string
description: Primary contact ID to filter on
example: '1234'
updated_since:
type: string
title: Updated since (timestamp)
format: date-time
example: '2020-09-30T07:43:32.000Z'
type:
type: string
title: Type
description: Type to filter on
format: string
example: Task
additionalProperties: false
ActivitiesSort:
type: object
x-apideck-schema-id: ActivitiesSort
example:
by: created_at
direction: desc
properties:
by:
type: string
x-apideck-enum-id: activities.sort_by
description: The field on which to sort the Activities
enum:
- created_at
- updated_at
example: created_at
direction:
$ref: '#/components/schemas/SortDirection'
additionalProperties: false
Activity:
type: object
x-apideck-schema-id: Activity
additionalProperties: false
required:
- type
x-apideck-weights:
id: critical
downstream_id: edge-case
activity_datetime: high
duration_seconds: medium
user_id: edge-case
account_id: edge-case
contact_id: edge-case
company_id: edge-case
lead_id: edge-case
opportunity_id: edge-case
owner_id: high
campaign_id: edge-case
case_id: edge-case
asset_id: edge-case
contract_id: edge-case
product_id: edge-case
solution_id: edge-case
custom_object_id: edge-case
type: critical
title: critical
description: medium
note: medium
location: medium
location_address: medium
all_day_event: medium
private: low
group_event: edge-case
event_sub_type: medium
group_event_type: edge-case
child: low
archived: low
deleted: low
show_as: edge-case
done: medium
start_datetime: high
end_datetime: high
duration_minutes: edge-case
activity_date: medium
end_date: medium
attendees: edge-case
reminder_set: edge-case
reminder_datetime: edge-case
video_conference_url: edge-case
video_conference_id: edge-case
updated_at: high
properties:
id:
description: The unique identifier of the activity
type: string
readOnly: true
example: '12345'
downstream_id:
type: string
description: The third-party API ID of original entity
example: '12345'
nullable: true
readOnly: true
activity_datetime:
description: The date and time of the activity
type: string
example: '2021-05-01T12:00:00.000Z'
nullable: true
duration_seconds:
description: The duration of the activity in seconds
type: integer
example: 1800
minimum: 0
nullable: true
user_id:
description: The user related to the activity
type: string
example: '12345'
nullable: true
account_id:
description: The account related to the activity
type: string
example: '12345'
nullable: true
contact_id:
description: The contact related to the activity
type: string
example: '12345'
nullable: true
company_id:
description: The company related to the activity
type: string
example: '12345'
nullable: true
opportunity_id:
description: The opportunity related to the activity
type: string
example: '12345'
nullable: true
lead_id:
description: The lead related to the activity
type: string
example: '12345'
nullable: true
owner_id:
description: The owner of the activity
type: string
example: '12345'
nullable: true
campaign_id:
description: The campaign related to the activity
type: string
example: '12345'
nullable: true
case_id:
description: The case related to the activity
type: string
example: '12345'
nullable: true
asset_id:
description: The asset related to the activity
type: string
example: '12345'
nullable: true
contract_id:
description: The contract related to the activity
type: string
example: '12345'
nullable: true
product_id:
description: The product related to the activity
type: string
example: '12345'
nullable: true
solution_id:
description: The solution related to the activity
type: string
example: '12345'
nullable: true
custom_object_id:
description: The custom object related to the activity
type: string
example: '12345'
nullable: true
type:
description: The type of the activity
type: string
x-apideck-enum-id: activities.type
enum:
- call
- meeting
- email
- note
- task
- deadline
- send-letter
- send-quote
- other
example: meeting
nullable: true
title:
description: The title of the activity
type: string
example: Meeting
nullable: true
description:
description: A description of the activity
type: string
example: More info about the meeting
nullable: true
note:
description: An internal note about the activity
title: Note (internal)
type: string
example: An internal note about the meeting
nullable: true
location:
description: The location of the activity
type: string
example: Space
nullable: true
location_address:
$ref: '#/components/schemas/Address'
all_day_event:
description: Whether the Activity is an all day event or not
type: boolean
example: false
nullable: true
private:
description: Whether the Activity is private or not
type: boolean
example: true
nullable: true
group_event:
description: Whether the Activity is a group event or not
type: boolean
example: true
nullable: true
event_sub_type:
description: The sub type of the group event
type: string
example: debrief
nullable: true
group_event_type:
description: The type of the group event
type: string
example: Proposed
nullable: true
child:
description: Whether the activity is a child of another activity or not
type: boolean
example: false
nullable: true
archived:
description: Whether the activity is archived or not
type: boolean
example: false
nullable: true
deleted:
description: Whether the activity is deleted or not
type: boolean
example: false
nullable: true
show_as:
type: string
x-apideck-enum-id: activities.show_as
enum:
- free
- busy
example: busy
nullable: true
done:
title: Done
description: Whether the Activity is done or not
type: boolean
example: false
nullable: true
start_datetime:
description: The start date and time of the activity
type: string
example: '2021-05-01T12:00:00.000Z'
nullable: true
end_datetime:
description: The end date and time of the activity
type: string
example: '2021-05-01T12:30:00.000Z'
nullable: true
duration_minutes:
description: The duration of the activity in minutes
type: integer
example: 30
nullable: true
readOnly: true
activity_date:
description: The date of the activity
type: string
example: '2021-05-01'
nullable: true
end_date:
description: The end date of the activity
type: string
example: '2021-05-01'
nullable: true
recurrent:
description: Whether the activity is recurrent or not
type: boolean
example: false
reminder_datetime:
description: The date and time of the reminder
type: string
example: '2021-05-01T17:00:00.000Z'
nullable: true
reminder_set:
description: Whether the reminder is set or not
type: boolean
example: false
nullable: true
video_conference_url:
description: The URL of the video conference
title: Meeting URL
type: string
example: https://us02web.zoom.us/j/88120759396
nullable: true
video_conference_id:
description: The ID of the video conference
title: Meeting ID
type: string
example: zoom:88120759396
nullable: true
custom_fields:
description: Custom fields of the activity
type: array
items:
$ref: '#/components/schemas/CustomField'
attendees:
type: array
items:
$ref: '#/components/schemas/ActivityAttendee'
custom_mappings:
$ref: '#/components/schemas/CustomMappings'
updated_by:
description: The user who last updated the activity
type: string
example: '12345'
readOnly: true
nullable: true
created_by:
description: The user who created the activity
type: string
example: '12345'
readOnly: true
nullable: true
updated_at:
description: The date and time when the activity was last updated
type: string
example: '2020-09-30T07:43:32.000Z'
readOnly: true
nullable: true
created_at:
description: The date and time when the activity was created
type: string
example: '2020-09-30T07:43:32.000Z'
readOnly: true
nullable: true
pass_through:
$ref: '#/components/schemas/PassThroughBody'
ActivityAttendee:
type: object
x-apideck-schema-id: ActivityAttendee
x-pii:
- name
- first_name
- middle_name
- last_name
- email_address
x-apideck-weights:
id: critical
name: critical
first_name: high
middle_name: low
last_name: high
prefix: low
suffix: edge-case
email_address: medium
is_organizer: medium
status: medium
user_id: low
properties:
id:
description: Unique identifier for the attendee
type: string
example: '12345'
readOnly: true
nullable: true
name:
description: Full name of the attendee
type: string
example: Elon Musk
minLength: 1
nullable: true
first_name:
description: First name of the attendee
type: string
example: Elon
nullable: true
middle_name:
description: Middle name of the attendee
type: string
example: D.
nullable: true
last_name:
description: Last name of the attendee
type: string
example: Musk
nullable: true
prefix:
description: Prefix of the attendee
type: string
example: Mr.
nullable: true
suffix:
description: Suffix of the attendee
type: string
example: PhD
nullable: true
email_address:
description: Email address of the attendee
type: string
example: [email protected]
nullable: true
is_organizer:
description: Whether the attendee is the organizer of the activity
type: boolean
example: true
nullable: true
status:
description: Status of the attendee
type: string
x-apideck-enum-id: activity-attendees.status
enum:
- accepted
- tentative
- declined
example: accepted
nullable: true
user_id:
description: The identifier for a related user
type: string
example: '12345'
readOnly: true
nullable: true
contact_id:
description: The identifier for a related contact
type: string
example: '12345'
readOnly: true
nullable: true
updated_at:
description: The last time the attendee was updated (ISO 8601)
type: string
format: date-time
example: '2017-08-12T20:43:21.291Z'
readOnly: true
nullable: true
created_at:
description: The time the attendee was created (ISO 8601)
type: string
format: date-time
example: '2017-08-12T20:43:21.291Z'
readOnly: true
nullable: true
additionalProperties: false
Address:
type: object
x-apideck-schema-id: Address
additionalProperties: false
x-apideck-weights:
id: edge-case
name: edge-case
type: critical
line1: high
line2: low
line3: edge-case
line4: edge-case
street_number: low
city: high
string: low
state: high
postal_code: high
country: high
latitude: low
longitude: low
county: edge-case
contact_name: edge-case
salutation: edge-case
phone_number: edge-case
fax: edge-case
email: edge-case
website: edge-case
row_version: edge-case
properties:
id:
description: Unique identifier for the address.
type: string
example: '123'
nullable: true
type:
type: string
description: The type of address.
x-apideck-enum-id: addresses.type
enum:
- primary
- secondary
- home
- office
- shipping
- billing
- other
example: primary
nullable: true
string:
type: string
description: The address string. Some APIs don't provide structured address data.
example: 25 Spring Street, Blackburn, VIC 3130
nullable: true
name:
description: The name of the address.
type: string
example: HQ US
nullable: true
line1:
type: string
example: Main street
description: 'Line 1 of the address e.g. number, street, suite, apt #, etc.'
nullable: true
line2:
type: string
example: 'apt #'
description: Line 2 of the address
nullable: true
line3:
type: string
example: 'Suite #'
description: Line 3 of the address
nullable: true
line4:
type: string
example: delivery instructions
description: Line 4 of the address
nullable: true
street_number:
type: string
example: '25'
description: Street number
nullable: true
city:
type: string
example: San Francisco
description: Name of city.
nullable: true
state:
type: string
example: CA
description: Name of state
nullable: true
postal_code:
type: string
example: '94104'
description: Zip code or equivalent.
nullable: true
country:
type: string
example: US
description: country code according to ISO 3166-1 alpha-2.
nullable: true
latitude:
description: Latitude of the address
type: string
example: '40.759211'
nullable: true
longitude:
description: Longitude of the address
type: string
example: '-73.984638'
nullable: true
county:
type: string
example: Santa Clara
description: Address field that holds a sublocality, such as a county
nullable: true
contact_name:
description: Name of the contact person at the address
type: string
example: Elon Musk
nullable: true
salutation:
description: Salutation of the contact person at the address
type: string
example: Mr
nullable: true
phone_number:
description: Phone number of the address
type: string
example: 111-111-1111
nullable: true
fax:
description: Fax number of the address
type: string
example: 122-111-1111
nullable: true
email:
description: Email address of the address
type: string
example: [email protected]
nullable: true
website:
description: Website of the address
type: string
example: https://elonmusk.com
nullable: true
notes:
description: Additional notes
type: string
title: Notes
example: Address notes or delivery instructions.
nullable: true
row_version:
$ref: '#/components/schemas/RowVersion'
BadRequestResponse:
type: object
x-apideck-schema-id: BadRequest
properties:
status_code:
type: number
description: HTTP status code
example: 400
error:
type: string
description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
example: Bad Request
type_name:
type: string
description: The type of error returned
example: RequestValidationError
message:
type: string
description: A human-readable message providing more details about the error.
example: Invalid Params
detail:
anyOf:
- type: string
example: Missing property foobar
- type: object
example:
missing:
- foobar: required
description: Contains parameter or domain specific information related to the error and why it occurred.
ref:
type: string
description: Link to documentation of error type
example: https://developers.apideck.com/errors#requestvalidationerror
BankAccount:
type: object
x-apideck-schema-id: BankAccount
additionalProperties: false
x-apideck-weights:
account_number: critical
account_name: medium
account_type: medium
iban: high
bic: medium
bsb_number: edge-case
branch_identifier: low
bank_code: low
bank_name: medium
currency: medium
properties:
bank_name:
type: string
title: Bank Name
description: The name of the bank
example: Monzo
nullable: true
account_number:
type: string
title: Bank Account Number
description: A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.
example: '123465'
nullable: true
account_name:
type: string
title: Bank Account Name
description: The name which you used in opening your bank account.
example: SPACEX LLC
nullable: true
account_type:
type: string
title: Account Type
x-apideck-enum-id: bank-accounts.account_type
enum:
- bank_account
- credit_card
- other
description: The type of bank account.
example: credit_card
nullable: true
iban:
description: The International Bank Account Number (IBAN).
type: string
example: CH2989144532982975332
nullable: true
bic:
description: The Bank Identifier Code (BIC).
type: string
example: AUDSCHGGXXX
nullable: true
routing_number:
type: string
title: Routing number
description: A routing number is a nine-digit code used to identify a financial institution in the United States.
example: '012345678'
nullable: true
bsb_number:
type: string
title: BSB Number
description: A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.
example: 062-001
nullable: true
branch_identifier:
type: string
title: Branch Identifier
description: A branch identifier is a unique identifier for a branch of a bank or financial institution.
example: '001'
nullable: true
bank_code:
type: string
title: Bank Code
description: A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.
example: BNH
nullable: true
currency:
$ref: '#/components/schemas/Currency'
CompaniesFilter:
type: object
x-apideck-schema-id: CompaniesFilter
example:
name: SpaceX
properties:
name:
type: string
description: Name of the company to filter on
example: SpaceX
additionalProperties: false
CompaniesSort:
type: object
x-apideck-schema-id: CompaniesSort
example:
by: created_at
direction: desc
properties:
by:
type: string
x-apideck-enum-id: companies.sort_by
description: The field on which to sort the Companies
enum:
- created_at
- updated_at
- name
example: created_at
direction:
$ref: '#/components/schemas/SortDirection'
additionalProperties: false
Company:
type: object
x-apideck-schema-id: Company
x-apideck-weights:
id: critical
name: critical
interaction_count: edge-case
owner_id: high
image: low
description: medium
vat_number: high
currency: medium
status: high
fax: low
annual_revenue: low
number_of_employees: low
industry: medium
ownership: low
sales_tax_number: medium
payee_number: edge-case
abn_or_tfn: edge-case
abn_branch: edge-case
acn: edge-case
first_name: edge-case
last_name: edge-case
parent_id: edge-case
bank_accounts: medium
websites: medium
addresses: high
social_links: low
phone_numbers: high
emails: high
row_type: edge-case
custom_fields: medium
tags: low
read_only: low
last_activity_at: low
deleted: medium
salutation: edge-case
birthday: edge-case
updated_by: edge-case
created_by: edge-case
updated_at: high
created_at: medium
required:
- name
additionalProperties: false
properties:
id:
description: Unique identifier for the company
type: string
readOnly: true
example: '12345'
name:
title: Name
description: Name of the company
type: string
example: SpaceX
nullable: true
interaction_count:
description: Number of interactions
type: integer
example: 1
readOnly: true
nullable: true
owner_id:
description: Owner ID
type: string
example: '12345'
nullable: true
image:
description: The Image URL of the company
type: string
example: https://www.spacex.com/static/images/share.jpg
nullable: true
description:
description: A description of the company
type: string
example: Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.
nullable: true
vat_number:
description: The VAT number of the company
type: string
example: BE0689615164
nullable: true
currency:
$ref: '#/components/schemas/Currency'
status:
description: The status of the company
type: string
example: Open
nullable: true
fax:
description: The fax number of the company
type: string
example: '+12129876543'
nullable: true
annual_revenue:
description: The annual revenue of the company
type: string
example: +$35m
nullable: true
number_of_employees:
description: Number of employees
type: string
example: 500-1000
nullable: true
industry:
description: The industry represents the type of business the company is in.
type: string
example: Apparel
nullable: true
ownership:
description: The ownership indicates the type of ownership of the company.
type: string
example: Public
nullable: true
sales_tax_number:
title: Sales tax number
description: A sales tax number is a unique number that identifies a company for tax purposes.
type: string
example: 12456EN
nullable: true
payee_number:
title: Payee number
description: A payee number is a unique number that identifies a payee for tax purposes.
type: string
example: 78932EN
nullable: true
abn_or_tfn:
title: ABN or TFN
description: An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.
type: string
example: 46 115 614 695
nullable: true
abn_branch:
title: ABN Branch
description: An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.
type: string
example: '123'
nullable: true
acn:
title: ACN
description: The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.
type: string
example: XXX XXX XXX
nullable: true
first_name:
$ref: '#/components/schemas/FirstName'
last_name:
$ref: '#/components/schemas/LastName'