/api/users/v1/user-groups/{userGroupId}/users
  • 17 Oct 2024
  • 4 Minutes to read
  • Contributors

/api/users/v1/user-groups/{userGroupId}/users


Article summary

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

Returns an array of the IDs of assigned users in a user group.

Path parameters
userGroupId
Required

The ID of the user group to retrieve the members of.

Exampleg56RCoZCtzv7borvp
Query parameters
limit
integer

The number of items to return in the response.

Minimum0
Example1
offset
integer

The number of items to skip before collecting the result.

Minimum0
Example0
filter
string

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

Responses
200

The assgined users of the user group were successfully retrieved.

Expand All
object
items
Array of object
object
userId
Exampleg56RCoZCtzv7borvp
count
number

The total number of items that matched the list parameters.

Example10
nextPage
string (url)

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

prevPage
string (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" } }
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

details
object
id
string

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 users.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.

Expand All
OneOf
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

details
object
headerName
string

The name of the given HTTP header which had multiple values.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

401

The request was missing required authentication information.

This error is not automatically retryable.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

404

The requested resource was not found.

This error is not automatically retryable.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

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 All
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

details
object
details
string

Additional details about this endpoint's rate limits.

500

An internal server error occurred. Please contact support@tulip.co if the error persists.

This error is not automatically retryable.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.


Was this article helpful?