Skip to navigation

Contract Group Item

View as Markdown

Retrieve a contract group by ID.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve a single contractGroupId to its contract group record. Other records, such as products, reference a contract group by ID, so use this endpoint when you have a contractGroupId and need the group it points to. Contract groups are read-only reference data.

Common Failure Scenarios

  • No contract group matches the id. This returns HTTP 404 with an empty body.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • 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 id.
(no message text)404The id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

ContractGroup
namestring<=64 characters
idlongOptional