Skip to content
forgit api docs

List users in a workspace

GET
/workspaces/{workspace}/members

Returns all members of the requested workspace.

This endpoint additionally supports filtering by email address, if called by a workspace administrator, integration or workspace access token. This is done by adding the following query string parameter:

  • q=user.email IN ("user1@org.com","user2@org.com")

When filtering by email, you can query up to 90 addresses at a time. Note that the query parameter values need to be URL escaped, so the final query string should be:

  • q=user.email%20IN%20(%22user1@org.com%22,%22user2@org.com%22)

Email addresses that you filter by (and only these email addresses) can be included in the response using the fields query parameter:

  • &fields=+values.user.email - add the email field to the default user response object
  • &fields=values.user.email,values.user.account_id - only return user email addresses and account IDs

Once again, all query parameter values must be URL escaped.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The list of users that are part of a workspace.

Media type application/json
Paginated Workspace Memberships

A paginated list of workspace memberships.

object
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
>= 1
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
>= 1
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
values
Array
0 unique items
object
type
required
string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
workspace
object
type
required
string
links
object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
members
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
owners
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
projects
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
repositories
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
snippets
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
uuid

The workspace’s immutable id.

string
name

The name of the workspace.

string
slug

The short label that identifies this workspace.

string
is_private

Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.

boolean
is_privacy_enforced

Indicates whether the workspace enforces private content, or whether it allows public content.

boolean
forking_mode

Controls the rules for forking repositories within this workspace.

  • allow_forks: unrestricted forking
  • internal_only: prevents forking of private repositories outside the workspace or to public repositories
string
Allowed values: allow_forks internal_only
created_on
string format: date-time
updated_on
string format: date-time
Example 
{
  "values": [
    {
      "workspace": {
        "forking_mode": "allow_forks"
      }
    }
  ]
}

400

Section titled “ 400 ”

When more than 90 emails were provided when querying by email.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

401

Section titled “ 401 ”

The request wasn’t authenticated.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}