Skip to navigation

Contract Group List

View as Markdown

List all contract groups.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieve every contract group defined on the platform. Other records, such as products, reference a contract group by its contractGroupId, so this endpoint returns the full set you need to resolve those IDs. Contract groups are read-only reference data.

Common Failure Scenarios

  • 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.

Related Endpoints

Authentication

AuthorizationBearer

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

Response

ContractGroup
namestring<=64 characters
idlongOptional