Skip to main content
GET
/
v1
/
entities
/
{entity_id}
/
users
List Users
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/users
{
  "users": [
    {
      "id": "54496de6-7cbd-4abb-8489-2675c4d1f8f7",
      "name": "Frank Malone",
      "email": "user@coinbase.com",
      "entity_id": "2c521d6c-1cfb-4371-bf9c-5a42938d3e75",
      "role": "AUDITOR"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}
Entity IDTo 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
  • .NET
  • Go
  • Python
  • CLI
  • TS/JS
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.

Path Parameters

​
entity_id
string
required

The entity ID

Query Parameters

​
cursor
string

Cursor used for pagination (last consumed record)

​
limit
integer

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.

​
pagination
object
⌘I