Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Catchpoint Contacts API

The Contacts API from Catchpoint — 3 operation(s) for contacts.

Catchpoint Contacts API is one of 31 APIs that Catchpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

5 operations 3 paths 28 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Contacts 5
GET
/v2/contacts/{contactIds}
Return contact details by the IDs passed.
1 param → 200
GET
/v2/contacts
Returns Contact details by parameters passed.
4 params → 200
DELETE
/v2/contacts
Deletes existing contacts by parameters passed.
3 params → 200
POST
/v2/contacts
Create a new contact based on the PostData.
1 param body → 200
PATCH
/v2/contacts/{contactId}
Update an existing contact based on the request body.
2 params body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactAPIModel (29 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactGetResponse] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactPostResponse] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactDeleteResponse] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.Enums.User.TestAccessRestrictionType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactGroupAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactRumAccessRestrictionAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactPostResponse]
object
6 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactPostResponse
object
5 properties
Catchpoint.Symphony.Enums.RUM.RumAccessType
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactGetResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactDeleteResponse]
object
6 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactTestAccessRestrictionAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactAPIModel
object
29 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int64]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactDashboardAPIModel
object
4 properties
Catchpoint.Symphony.Enums.ContactPrimaryDashboardType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactGetResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactNotificationTypeAPIModel
object
3 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.Enums.Alerts.ContactNotificationType
integer
Catchpoint.Symphony.Enums.SupportedTimeZone
integer
Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Contact.ContactDeleteResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-contacts-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

Catchpoint Account API
Catchpoint Alerts API
Catchpoint ASNs API
Catchpoint Assertions API
Catchpoint CommandControl API
Catchpoint Credentials API
Catchpoint Divisions API
Catchpoint EndpointDevice API
Catchpoint EndpointDevicePerformance API
Catchpoint Folder API
Catchpoint Insights API
Catchpoint Instances API