List Users

List all users associated with a given entity.

GET /v1/entities/{entity_id}/users

List Users

cURL

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/users

200

{
  "users": [
    {
      "id": "54496de6-7cbd-4abb-8489-2675c4d1f8f7",
      "name": "Frank Malone",
      "email": "[e-mail]",
      "entity_id": "2c521d6c-1cfb-4371-bf9c-5a42938d3e75",
      "role": "AUDITOR",
      "roles": [
        "AUDITOR"
      ],
      "secondary_permissions": [
        "VIDEO_APPROVER"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}

Entity ID

To retrieve your entity_id, use List Portfolios.

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

UsersService usersService = PrimeServiceFactory.createUsersService(client);

ListUsersRequest request = new ListUsersRequest.Builder()
    .entityId("ENTITY_ID_HERE")
    .build();

ListUsersResponse response = usersService.listUsers(request);

For more information, please visit the Prime Java SDK.

.NET

var usersService = new UsersService(client);

var request = new ListUsersRequest("ENTITY_ID_HERE");

var response = usersService.ListUsers(request);

For more information, please visit the Prime .NET SDK.

Go

usersService := users.NewUsersService(client)

request := &users.ListEntityUsersRequest{
    EntityId: "ENTITY_ID_HERE",
}

response, err := usersService.ListEntityUsers(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = ListUsersRequest(
    entity_id="ENTITY_ID_HERE",
)

response = prime_client.list_users(request)

For more information, please visit the Prime Python SDK.

CLI

primectl list-entity-users --help

For more information, please visit the Prime CLI.

TS/JS

const usersService = new UsersService(client);

usersService.listUsers({
    entityId: 'ENTITY_ID_HERE'
}).then(async (response) => {
    console.log('Users: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

entity_id · string · required

The entity ID

Query Parameters

cursor · string

Cursor used for pagination (last consumed record)

limit · integer<int32>

Number of items to retrieve

sort_direction · enum<string> · default: DESC

Sorting order

Available options: DESC, ASC

Response

200 - application/json

A successful response.

users · object[]

The entity users.

Show child attributes

pagination · object

Show child attributes