---
title: "Get CRB users"
method: GET
path: "/crbs/{crb_id}/users"
tags: ["Users"]
---

# Get CRB users

`GET /crbs/{crb_id}/users`

## Request

- Base URL: `https://sandbox-api.greencheckverified.com`
- URL: `https://sandbox-api.greencheckverified.com/crbs/{crb_id}/users`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/greencheckverified/apis/green-check-access/docs/crbs/:crb_id/users/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `crb_id` string, required

## Query parameters

- `include_archived` boolean

## Response `200`

Ok

- User[]
  - `id` string, uuid, required
  - `first_name` string, required: First Name
  - `middle_initial` string, nullable, required: Middle Initial
  - `last_name` string, required: Last Name
  - `email` string, required: Email
  - `phone` string, required: Phone Number - (###) ####-####
  - `role` 'account_owner' | 'admin' | 'standard', required: User's role within the CRB
  - `status` 'pending' | 'confirmed' | 'confirmed_verified' | 'archived', required: User's account status. Pending users have not accepted their invitation, confirmed users have, and confirmed_verified users have also uploaded their identity information.
  - `created_on` string, date-time, required
  - `last_login` string, date-time, nullable, required
  - `address` string, nullable, required: Street Address
  - `city` string, required: City
  - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'AS' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MH' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UM' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY' | 'AA' | 'AE' | 'AP', required: Enumeration of all of the United States
  - `zip` string, required: Postal Code
  - `date_of_birth` string, nullable, required: Date of Birth
  - `ssn` string, nullable, required: Social Security Number
  - `identification` AccessUserIdentification, required
    - `id_type` string, nullable, required: Identification Type
    - `id_number` string, nullable, required: Identification Number
    - `id_state` string, nullable, required: State that issued the identification
    - `id_issue_date` string, nullable, required: Identification Issue Date
    - `id_expiration_date` string, nullable, required: Identification Expiration Date

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Validation Failed

---

[API](https://skmtc.dev/greencheckverified/apis/green-check-access.md) - [All operations](https://skmtc.dev/greencheckverified/apis/green-check-access/llms.txt) - [OpenAPI document](https://skmtc.dev/greencheckverified/apis/green-check-access/revisions/fb63a7a6151b?raw)