Contact Points

List contact points

List contact points owned by the organization associated with the API key. Supports filtering by status and type. FASTN contact points are excluded from results.

get/v1/api/contactPoints

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/contactPoints
  • Auth: HTTP bearer

Query parameters

statusstring[]
typestring[]
sortBy'createdAt' | 'updatedAt' required
pageinteger

Zero-based page number to retrieve. Defaults to 0.

sizeinteger

Number of results per page. Must be between 1 and 100; defaults to 10.

sortOrder'asc' | 'desc' required

Required direction used to sort results. Accepts asc or desc.

nulls'first' | 'last'

Placement of null values in sorted results. Accepts first or last.

Response

200 - Success

totalinteger required

Total number of matching contact points across all pages.

Example response

{
  "total": 1,
  "data": [
    {
      "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "createdAt": "2025-07-15T11:20:00.000Z",
      "updatedAt": "2025-07-15T11:25:00.000Z",
      "type": "WEBHOOK",
      "status": "ACTIVE",
      "name": "Ops webhook",
      "webhookUrl": "https://hooks.example.com/perigon/monitors",
      "webhookSecret": "whsec_example_secret",
      "isVerified": true,
      "verifiedAt": "2025-07-15T11:25:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.