On-Call User Group

Get On-Call User Group

Endpoint to retrieve a single On-Call User Group by ID

post/workspace-user-group/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the On-Call User Group to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "workspaceType": true,
    "workspaceTeamId": true,
    "name": true,
    "handle": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceType": "Slack",
    "workspaceGroupId": "S0604QSJC",
    "workspaceTeamId": "Example short text",
    "name": "Payments on-call",
    "handle": "payments-oncall",
    "onCallDutyPolicySchedules": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "syncState": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "syncedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "nextSyncAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.