---
title: "List company users"
method: POST
path: "/companies/v1/users"
tags: ["Companies"]
---

# List company users

`POST /companies/v1/users`

Lists users in a company along with their roles and metadata.

## Request body

- S12ContractorsV1ListCompanyUserMetadataRequest
  - `company_id` string, required — Required. The ID of the contractor company.
  - `filter` S12ContractorsV1ContractorCompanyUserFilter — ContractorCompanyUserFilter is used to filter contractor company users.
    - `search` string — Optional. The search string to filter by. If not provided, all unfiltered results will be returned.
    - `user_status` 'USER_STATUS_ACTIVE' | 'USER_STATUS_DEACTIVATED' — - USER_STATUS_ACTIVE: Include only active users. - USER_STATUS_DEACTIVATED: Include only deactivated users.
  - `sort_field` 'USER_SORT_FIELD_USER_NAME' — ContractorCompanyUserSortField is used to define the sorting criteria of contractor company users. - USER_SORT_FIELD_USER_NAME: Sort by user name.
  - `page_size` integer — The number of users to return in a single request.
  - `page_token` string — If present, will fetch the next page of results. This must be the value of `next_page_token` from the response.
  - `sort_direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

## Response `200`

A successful response.

- S12ContractorsV1ListCompanyUserMetadataResponse
  - `company_user_metadata_list` S12ContractorsV1CompanyUserMetadata[] — The list of users in the company.
    - `user_doc` S12CommonUserDocument
      - `id` string — UUID of the user
      - `email` string — Email of the user
      - `first_name` string — First name of the user
      - `last_name` string — Last name of the user
      - `timezone` string — What timezone the user is in
      - `profile_picture` string — URL of the profile picture of the user
      - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated
      - `external_mappings` S12CommonUserDocumentUserExternalMappings
        - `edapp_id` string
      - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT'
      - `profile_image` S12CommonMedia
        - `id` string
        - `token` string
        - `filename` string — full file name, including file extension
        - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file.
      - `last_seen` string, date-time — Timestamp of when the user last interacted with the system. May be empty.
      - `email_confirmed` boolean — Whether or not the user has confirmed their email.
      - `created_at` string, date-time — Timestamp of when the user was created.
      - `language` 'LANGUAGE_UNSPECIFIED' | 'LANGUAGE_EN_US' | 'LANGUAGE_EN_GB' | 'LANGUAGE_DE_DE' | 'LANGUAGE_ES_ES' | 'LANGUAGE_FR_FR' | 'LANGUAGE_PT_BR' | 'LANGUAGE_NL_NL' — - LANGUAGE_UNSPECIFIED: Language unspecified - LANGUAGE_EN_US: Language en-US - LANGUAGE_EN_GB: Language en-GB - LANGUAGE_DE_DE: Language de-DE - LANGUAGE_ES_ES: Language es-ES - LANGUAGE_FR_FR: Language fr-FR - LANGUAGE_PT_BR: Language pt-BR - LANGUAGE_NL_NL: Language nl-NL
      - `phone_number` string — Phone number of the user
    - `role` 'CONTRACTOR_COMPANY_ROLE_UNSPECIFIED' | 'CONTRACTOR_COMPANY_ROLE_MEMBER' | 'CONTRACTOR_COMPANY_ROLE_DELEGATED_MANAGER' — The role of a user within a contractor company. - CONTRACTOR_COMPANY_ROLE_MEMBER: The default role - member. - CONTRACTOR_COMPANY_ROLE_DELEGATED_MANAGER: The user is a key contact (previously known as delegated company manager).
  - `next_page_token` string — The next page token.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)