Skip to navigation

Contract Group Find

View as Markdown

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 returns HTTP 404 with an empty body.
  • The name parameter 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 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read contract groups.
(no message text)404No contract group matches the name.
(no message text)404The name parameter is missing or repeated.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

namestringRequired

Response

ContractGroup
namestring<=64 characters
idlongOptional