Get Company Custom Notification Flows

GET/companies/{id}/custom-notification-flows

Agency-scoped keys

This endpoint is not available for agency-scoped API keys.

Summary

Returns a paginated list of custom notification flows for a company within the API key scope. Requires read:companies.

Includes enabled and disabled custom email flows. Excludes standard notification settings and webhooks. Email templates are returned as saved, without resolving dynamic tokens.

URL Parameters

Name	Type	Required	Description
id	string	Yes	Company ObjectId or reference

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number (default 1)
limit	integer	No	Records per page (default 50, max 200)
query	string	No	Case-insensitive search against flow name and trigger
sortBy	string	No	name, trigger, id; default name
sortOrder	string	No	asc or desc; default asc
fields	string	No	Comma-separated response fields or nested dot paths

Request Example

cURL

curl -X GET 'https://api.requidex.com/api/open/v1/companies/{id}/custom-notification-flows' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/companies/{id}/custom-notification-flows",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer <API_KEY>",
      Accept: "application/json",
    },
  },
);

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/companies/{id}/custom-notification-flows',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/companies/{id}/custom-notification-flows", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Each item in data contains the following fields. meta contains page, limit and total; the total counts matching records before pagination.

Field	Type	Description
id	string	Flow reference
company	string	Company ObjectId
name	string	Flow name
enabled	boolean	Whether the flow is enabled
trigger	string	Notification trigger
conditions	object[]	Show child attributes id string - Condition reference field string - Condition field operator string - Comparison operator value string - Stored condition value
recipientEmail	string	Configured recipient mailboxes
emailMode	string	Allowed values: standard, introduction, custom
emailBody	string	Saved email editor content; dynamic tokens are not resolved
emailSubject	string	Saved subject template; empty uses the standard subject
offsetValue	number or null	Reminder offset amount, where configured
offsetUnit	string or null	Reminder offset unit: days, weeks or months
schedule	object or null	Show child attributes frequency string - daily, weekly or monthly daysOfWeek string[] - Lowercase weekday names dayOfMonth integer or null - Day of month (1–31) hourOfDay integer - Scheduled hour (0–23) nextRun string or null - Next run timestamp lastRun string or null - Last run timestamp

Response Example (200)

{
  "success": true,
  "data": [
    {
      "id": "flowref001",
      "company": "507f1f77bcf86cd799439011",
      "name": "Assignment alerts",
      "enabled": true,
      "trigger": "assignment_created",
      "conditions": [],
      "recipientEmail": "operations@example.com",
      "emailMode": "standard",
      "emailBody": "",
      "emailSubject": "",
      "offsetValue": null,
      "offsetUnit": null,
      "schedule": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 1
  }
}

MCP Tool

The MCP server exposes this operation as open_api_list_company_custom_notification_flows with inputs id, page, limit, query, sortBy, sortOrder and fields.

Errors

HTTP Status	Description
400	Invalid filters or parameters
401	Missing, invalid, revoked, or expired API key
403	Missing scope, IP restriction, or agency-scoped key
404	Company not found within the key scope
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Failed to fetch company custom notification flows