---
title: "/api/users/v1/users/{userId}/user-groups"
slug: "apiusersv1usersuseriduser-groups"
updated: 2024-10-17T20:32:06Z
published: 2024-10-17T20:32:06Z
---

> ## 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/users/{userId}/user-groups

Get/api/users/v1/users/{userId}/user-groups

Returns an array of user group IDs that the user is currently a member of.

Path parametersuserIdRequired

The ID of the user to retrieve the assigned user groups.

Exampleg56RCoZCtzv7borvp

Query parameterslimitinteger

The number of items to return in the response.

Minimum0Example1
offsetinteger

The number of items to skip before collecting the result.

Minimum0Example0
filterstring

Filters the result using OData 4.01 syntax. Supports filtering on the `userGroupId` field. Only supports the `eq` and `or` operators.

Responses200

The assigned user groups of the user were successfully retrieved.

<select class='api-response-data' aria-label='Media type'><option value='a014f5ec-91af-4441-b820-abb7c5bed6a5'>application/json</option>
</select>Expand Allobject items Array of object   object userGroupIdExampleg56RCoZCtzv7borvp

countnumber    

The total number of items that matched the list parameters.

Example10
nextPagestring  (url)    

A URL at which the next page of results can be fetched.

prevPagestring  (url)    

A URL at which the previous page of results can be fetched.

errors Array of object (PaginatedItemError)   

A list of errors per item that is omitted from the paginated response, if any.

object Example{
  "errorCode": "generic.internal",
  "message": "Something went wrong.",
  "retryable": false,
  "details": {
    "id": "invalidRecordId"
  }
}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 idstring    

The ID of the omitted record.

400

An error occurred. The Tulip error codes `generic.customerIdRequired`, `generic.workspaceIdRequired`, `generic.invalidParams`, `http.invalidBodyJson`, `http.invalidHeaders`, `http.multiValueHeader`, and `userGroups.invalidFilter` 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.

<select class='api-response-data' aria-label='Media type'><option value='852bc557-02a3-4ece-964f-8bbc68a6c4aa'>application/json</option>
</select>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.

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.

401

The request was missing required authentication information.

This error is not automatically retryable.

<select class='api-response-data' aria-label='Media type'><option value='eeb50cf9-7d12-434c-aec5-daa4d505288a'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='2d30f130-4593-4484-b869-2b9ad1e62116'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='f898d048-9bac-47ec-ae1e-a94979e6078b'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='cf9de4c1-a93c-40f2-94d2-cbcd7d078dfa'>application/json</option>
</select>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.
