Fetch a single account group by ID
Returns the account group identified by account_group_id. Soft-deleted account groups are not returned.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/contracts.v1.Contracts/GetAccountGroup" \ -H "Content-Type: application/json" \ -d '{ "accountGroupId": "string", "workspaceId": "string" }'{
"accountGroup": {
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"id": "EBESExQVFhcYGRobHB0eHw==",
"members": [
"string"
],
"name": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"workspaceId": "string"
}
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}ListContracts
Returns a paged list of full contracts in the workspace, ordered by the requested sort field and direction. Filtering by contract type and by status, and sorting, are all applied server side, so the client passes the active tab and sort here rather than filtering a fetched page. Each page carries hydrated entities, so no follow-up GetContracts is needed.
ListAccountGroups
Returns a paged list of account group IDs. Use GetAccountGroup or GetAccountGroups to hydrate the full records.