---
title: "Find users of a service"
method: GET
path: "/v1/api/services/{serviceExternalId}/users"
tags: ["Services"]
---

# Find users of a service

`GET /v1/api/services/{serviceExternalId}/users`

## Path parameters

- `serviceExternalId` string, required

## Query parameters

- `role` 'admin' | 'view-and-refund' | 'view-only' | 'view-and-initiate-moto' | 'view-refund-and-initiate-moto' | 'super-admin'

## Response `200`

OK

- User[]
  - `_links` Link[]
    - `href` string
    - `method` string
    - `rel` string
  - `disabled` boolean
  - `email` string
  - `external_id` string
  - `features` string
  - `last_logged_in_at` string, date-time
  - `login_counter` integer
  - `otp_key` string
  - `password` string
  - `provisional_otp_key` string
  - `provisional_otp_key_created_at` string, date-time
  - `second_factor` 'SMS' | 'APP'
  - `service_roles` ServiceRole[]
    - `role` Role
      - `description` string
      - `name` 'admin' | 'view-and-refund' | 'view-only' | 'view-and-initiate-moto' | 'view-refund-and-initiate-moto' | 'super-admin'
      - `permissions` Permission[]
        - `description` string
        - `name` string
    - `service` Service
      - `_links` Link[]
        - `href` string
        - `method` string
        - `rel` string
      - `agent_initiated_moto_enabled` boolean
      - `archived` boolean
      - `archived_date` string, date-time
      - `collect_billing_address` boolean
      - `created_date` string, date-time
      - `current_go_live_stage` 'NOT_STARTED' | 'ENTERED_ORGANISATION_NAME' | 'ENTERED_ORGANISATION_ADDRESS' | 'CHOSEN_PSP_ADYEN' | 'CHOSEN_PSP_STRIPE' | 'CHOSEN_PSP_GOV_BANKING_WORLDPAY' | 'GOV_BANKING_MOTO_OPTION_COMPLETED' | 'TERMS_AGREED_ADYEN' | 'TERMS_AGREED_STRIPE' | 'TERMS_AGREED_GOV_BANKING_WORLDPAY' | 'DENIED' | 'LIVE'
      - `current_psp_test_account_stage` 'NOT_STARTED' | 'REQUEST_SUBMITTED' | 'CREATED'
      - `custom_branding` object
      - `default_billing_address_country` string
      - `experimental_features_enabled` boolean
      - `external_id` string
      - `gateway_account_ids` string[]
      - `id` integer
      - `internal` boolean
      - `merchant_details` MerchantDetails
        - `address_city` string
        - `address_country` string
        - `address_line1` string
        - `address_line2` string
        - `address_postcode` string
        - `email` string
        - `name` string
        - `telephone_number` string
        - `url` string
      - `name` string
      - `redirect_to_service_immediately_on_terminal_state` boolean
      - `sector` string
      - `service_features` object
      - `service_name` object
      - `takes_payments_over_phone` boolean
      - `went_live_date` string, date-time
  - `session_version` integer
  - `telephone_number` string

## Other responses

- `400` — If query parameter 'role' is not one of [admin, view-and-refund, view-only, view-and-initiate-moto, view-refund-and-initiate-moto, super-admin]
- `404` — Not found

---

[API](https://skmtc.net/government-digital-service/apis/adminusers-api.md) · [All operations](https://skmtc.net/government-digital-service/apis/adminusers-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/government-digital-service/adminusers-api/versions/17f1bf916172/schema)