--- title: "/api/users/v1/user-groups/{userGroupId}" slug: "apiusersv1user-groupsusergroupid" updated: 2024-10-17T20:32:06Z published: 2024-10-17T20:32:06Z canonical: "support.tulip.co/apiusersv1user-groupsusergroupid" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.tulip.co/llms.txt > Use this file to discover all available pages before exploring further. # /api/users/v1/user-groups/{userGroupId} Get/api/users/v1/user-groups/{userGroupId} Gets a single user group. Path parametersuserGroupIdRequired The ID of the user group that will be retrieved. Responses200 The user group details were successfully retrieved. Expand Allobject Representation of a user group. Example{ "id": "78M2aGebq5MjhKafN", "name": "Machine maintenance team", "description": "People responsible for the maintenance of the machines in the factory." }idExampleg56RCoZCtzv7borvp namestring The user group's name. descriptionstring A human-readable description of the user group and what the group represents. avatarstring The storage key of the avatar which can be used to retrieve the avatar image's signed URL. assignedUsersCountnumber The number of users assigned to the user group. createdatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp lastModifiedatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp archivedatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp 400 An error occurred. The Tulip error codes `generic.customerIdRequired`, `generic.workspaceIdRequired`, `generic.invalidParams`, `http.invalidBodyJson`, `http.invalidHeaders`, and `http.multiValueHeader` all use the 400 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code. Expand AllOneOfobjecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. detailsobject headerNamestring The name of the given HTTP header which had multiple values. 401 The request was missing required authentication information. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. 404 The requested resource was not found. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. 429 Too many requests have been made to this endpoint in a short time period. This error is not automatically retryable. Expand Allobject errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. detailsobject detailsstring Additional details about this endpoint's rate limits. 500 An internal server error occurred. Please contact [support@tulip.co](mailto:support@tulip.co) if the error persists. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client.