Contract Group Find
Find a contract group by name.
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Look up a contract group by its name to get its id. Use this endpoint when you know a contract group by name and need the id that other records reference it by. Contract groups are read-only reference data.
Common Failure Scenarios
- No contract group matches the
name. This returnsHTTP 404with an empty body. - The
nameparameter is missing or repeated (HTTP 404). - The caller’s user type, or the API key’s permissions, can’t read contract groups. This returns
HTTP 401with"Access is denied".
Error Messages
Related Endpoints
- Use
contractGroupItemto resolve a contract group byidinstead. - Use
contractGroupListto retrieve every contract group.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
name
Response
ContractGroup
name
id