Risk Time Period Find
Find a risk time period by name.
Available to: Organization administrators (own organization’s risk time periods)
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Look up a risk time period by its name to get its id. Use this endpoint when you know a risk time period by name and need the id that other records reference it by.
Common Failure Scenarios
- No risk time period matches the
name, or thenameis for a risk time period you can’t access. Both returnHTTP 404with an empty body, notHTTP 401. - The
nameparameter 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
riskTimePeriodItemto resolve a risk time period byidinstead. - Use
riskTimePeriodFindsto look up several risk time periods by name in one call.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
name
Response
RiskTimePeriod
name
startTime
stopTime
id
organizationId