Source Groups

List source groups

List source groups owned by the organization associated with the API key, as well as publicly visible source groups. Supports filtering by name and domain.

get/v1/api/sourceGroups

Request

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

Query parameters

namestring
domainstring
sortBy'id' | 'createdAt' | 'updatedAt' | 'name' 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 source groups across all pages.

Example response

{
  "total": 1,
  "data": [
    {
      "id": 17,
      "createdAt": "2025-05-10T08:00:00.000Z",
      "updatedAt": "2025-07-20T12:45:00.000Z",
      "name": "tier-1-tech",
      "displayName": "Tier 1 Tech",
      "description": "Major technology news outlets.",
      "domains": [
        "reuters.com",
        "apnews.com",
        "bbc.com",
        "cnn.com"
      ],
      "organizationId": 1001,
      "visible": true
    }
  ]
}

Changes

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