Skip to navigation

Contract Group Finds

View as Markdown

Find several contract groups by name.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Look up multiple contract groups by name in a single call, returning each matching record, including its id. Prefer this over repeated contractGroupFind calls when you need to resolve several names at once. Contract groups are read-only reference data.

Common Failure Scenarios

  • A name in names that doesn’t match a contract group is left out of the response array. The call still succeeds, so compare the returned records against the names you requested.
  • The names 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)404The names parameter is missing or repeated.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

nameslist of stringsRequired

Response

ContractGroup
namestring<=64 characters
idlongOptional