Risk Time Period Finds
Find several risk time periods by name.
Available to: Organization administrators (own organization’s risk time periods)
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Look up multiple risk time periods by name in a single call, returning each matching record, including its id. Prefer this over repeated riskTimePeriodFind calls when you need to resolve several names at once.
Common Failure Scenarios
- A name in
namesthat doesn’t match a risk time period, or matches one you can’t access, is left out of the response array. The call still succeeds, so compare the returned records against the names you requested. - The
namesparameter is missing or repeated (HTTP 404). - The caller’s user type, or the API key’s permissions, can’t read risk time periods. This returns
HTTP 401with"Access is denied".
Error Messages
Related Endpoints
- Use
riskTimePeriodFindto look up a single risk time period by name. - Use
riskTimePeriodItemsto resolve several risk time periods byidinstead.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
names
Response
RiskTimePeriod
name
startTime
stopTime
id
organizationId