> ## Documentation Index > Fetch the complete documentation index at: https://developer.meetergo.com/llms.txt > Use this file to discover all available pages before exploring further. # List users > Retrieves a list of users from your company with optional filtering and pagination. Admin access required. ## OpenAPI ````yaml /openapi.json get /v4/user openapi: 3.0.0 info: title: meetergo Platform API description: >- Scheduling, CRM and invoicing in one API: create users, manage availability and bookings, connect calendars, keep contacts and deals in sync, and take an offer through to a paid invoice. version: 3.274.0 contact: {} termsOfService: https://www.meetergo.com/tos/ servers: [] security: [] tags: - name: User V4 description: Create and manage users in your workspace - name: Meeting Type V4 description: Configure meeting templates with durations, buffers, and conferencing - name: availability description: Manage weekly schedules and availability settings - name: Booking V4 description: Create new bookings - name: Booking Availability V4 description: Query available time slots for booking - name: Appointment V4 description: Manage existing appointments - name: Attendee V4 description: Manage attendee details and notes - name: Calendar Connections V4 description: Connect and sync external calendars - name: Signatures V4 description: >- Send PDFs for e-signature and download the signed, eIDAS-grade document (DocuSeal-compatible) - name: WhatsApp V4 description: >- Send and receive WhatsApp messages by phone number and read conversation history - name: One Time Booking Link V4 description: Create single-use booking links - name: availability-exception description: Override availability for specific dates - name: Booking Link V4 description: Configure various booking page types - name: Personal Page V4 description: Manage user profile pages - name: Handoff V4 description: Reassign meetings to other hosts - name: Calendar Auth V4 description: OAuth callbacks for calendar providers - name: CRM Contacts description: >- Create, find, and update the people in your CRM, including their custom data fields - name: CRM Deals description: >- Create, update, and track deals through pipeline stages (incl. per-deal activity history) - name: CRM Pipelines description: Manage pipelines and their stages - name: CRM Tasks description: Tasks on contacts, deals and companies - name: CRM Notes description: Notes on contacts, deals and companies - name: CRM Attachments description: Files attached to contacts, deals and companies - name: CRM Communications description: Logged calls, messages and meetings on contacts, deals and companies - name: CRM Email Sync description: Read the email history synced from connected mailboxes (read-only) - name: Data Fields description: >- Define the custom fields a contact can carry; their `name` is the key used in a contact's additionalData - name: Invoicing Documents description: >- Offers and invoices: create a draft, finalize it into a numbered e-invoice, send it, record payments, and run Mahnwesen - name: Invoicing Products description: Reusable products for invoice line items - name: Invoicing Settings description: Seller details, tax treatment, bank accounts, and number ranges - name: Invoicing Recurring description: >- Recurring schedules, billing runs over completed meetings, buyer prefill, and DATEV export - name: Queue V4 description: Round-robin and queue-based routing (Beta) - name: Queue User Group V4 description: Manage queue user groups (Beta) - name: Meeting Type Template V4 description: Reusable meeting type configurations (Beta) - name: Attendee Pending V4 description: Manage pending attendee approvals (Beta) - name: Provisional Booking V4 description: Manage provisional/unconfirmed bookings (Beta) paths: /v4/user: get: tags: - User V4 summary: List users description: >- Retrieves a list of users from your company with optional filtering and pagination. Admin access required. operationId: listUsers parameters: - name: userType required: false in: query description: Filter users by type. If not specified, returns all user types. schema: $ref: '#/components/schemas/UserType' - name: limit required: false in: query description: Maximum number of users to return schema: minimum: 1 maximum: 100 default: 50 example: 20 type: number - name: offset required: false in: query description: Number of users to skip for pagination schema: minimum: 0 default: 0 example: 0 type: number responses: '200': description: Users retrieved successfully content: application/json: schema: $ref: '#/components/schemas/ListUsersResponseDto' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' security: - ApiUserHeader: [] - JWT: [] - ApiKey: [] components: schemas: UserType: type: string enum: - standard - resource - api-platform - partner - viewer ListUsersResponseDto: type: object properties: users: description: Array of users matching the query criteria type: array items: $ref: '#/components/schemas/UserResponseDto' total: type: number description: >- Total number of users matching the query criteria (before pagination) minimum: 0 example: 25 count: type: number description: Number of users returned in this response minimum: 0 example: 10 offset: type: number description: Number of users skipped (pagination offset) minimum: 0 example: 0 required: - users - total - count - offset UserResponseDto: type: object properties: id: type: string description: User unique identifier companyId: type: string nullable: true description: Company ID the user belongs to email: type: string description: User email address isAdmin: type: boolean description: Whether user is a company administrator familyName: type: string description: User family name/lastname givenName: type: string description: User given name/firstname picture: type: string description: URL to user profile picture createdAt: type: string description: User creation timestamp updatedAt: type: string description: User last update timestamp deletedAt: type: string nullable: true description: User deletion timestamp title: type: string description: User job title anonymousBooking: type: boolean description: Whether user allows anonymous booking anonymousCalendarActivity: type: boolean description: Whether user allows anonymous calendar activity slug: type: string description: User unique slug for public URLs showGettingStartedList: type: boolean description: Whether to show getting started list recieveEmailMarketing: type: boolean description: Whether user receives marketing emails timezone: type: string description: User timezone language: description: User preferred language allOf: - $ref: '#/components/schemas/Language' referralId: type: string description: Referral ID if user was referred personalPage: description: User personal page configuration allOf: - $ref: '#/components/schemas/PersonalPageResponseDto' calendarSyncProviders: nullable: true description: Calendar sync provider settings allOf: - $ref: '#/components/schemas/CalendarSync' defaultAvailabilityId: type: string description: Default availability ID aircallUserId: type: string description: Aircall user ID phone: type: string description: User phone number userType: description: Type of user (standard, resource, api-platform) allOf: - $ref: '#/components/schemas/UserType' wherebyApiKey: type: string nullable: true description: Whereby API key fullName: type: string description: User full name (computed) groupIds: description: IDs of groups the user belongs to type: array items: type: string groupAdminIds: description: IDs of groups the user is admin of type: array items: type: string meetingTypeIds: description: IDs of meeting types owned by the user type: array items: type: string meetingTypeTemplateIds: description: IDs of meeting type templates created by the user type: array items: type: string appointmentIds: description: IDs of appointments where user is a host type: array items: type: string workspaceIds: description: IDs of workspaces the user belongs to type: array items: type: string reminderIds: description: IDs of reminders owned by the user type: array items: type: string formIds: description: IDs of forms owned by the user type: array items: type: string queueIds: description: IDs of queues the user belongs to type: array items: type: string queueUserGroupIds: description: IDs of queue user groups the user belongs to type: array items: type: string availabilityIds: description: IDs of availabilities owned by the user type: array items: type: string company: description: Company basic information allOf: - $ref: '#/components/schemas/CompanyBasicDto' required: - id - isAdmin - familyName - givenName - createdAt - updatedAt - title - anonymousBooking - anonymousCalendarActivity - slug - showGettingStartedList - recieveEmailMarketing - timezone - language - personalPage - userType - fullName ApiError: type: object required: - statusCode - message properties: statusCode: type: integer example: 400 message: oneOf: - type: string - type: array items: type: string description: >- A sentence, or the list of field constraints that failed. Validation errors name the offending property. example: - limit must not be greater than 100 error: type: string example: BadRequestException Language: type: string enum: - en - de - fr - es - 'no' - nl - it - pl - se - tr - da PersonalPageResponseDto: type: object properties: useCustomColors: type: boolean description: Whether custom colors are enabled for the personal page primaryColor: type: string description: Primary color for the personal page theme secondaryColor: type: string description: Secondary color for the personal page theme headerImage: type: string nullable: true description: Header image URL for the personal page description: type: string description: Personal page description text onlineProfiles: description: Online profiles and social media links allOf: - $ref: '#/components/schemas/OnlineProfiles' meetingTypes: description: Meeting types assigned to this personal page type: array items: $ref: '#/components/schemas/MeetingTypeBasicResponseDto' required: - useCustomColors - primaryColor - secondaryColor - description - onlineProfiles CalendarSync: type: object properties: id: type: string type: allOf: - $ref: '#/components/schemas/CalendarSyncProvider' required: - id - type CompanyBasicDto: type: object properties: id: type: string description: Company unique identifier name: type: string description: Company name slug: type: string description: Company unique slug logo: type: string description: Company logo URL description: type: string description: Company description timezone: type: string description: Company timezone language: type: string description: Company language tier: type: string description: Effective plan tier (trial resolves to the trialled tier) isInTrial: type: boolean description: Whether the company is in a trial featureAccess: type: object description: >- Resolved plan entitlements and limits. Lets an integration explain a limit before hitting it instead of failing into one. additionalProperties: true required: - id - name - slug - timezone - language OnlineProfiles: type: object properties: linkedIn: type: string facebook: type: string twitter: type: string instagram: type: string xing: type: string phone: type: string email: type: string customLinks: type: array items: $ref: '#/components/schemas/CustomLink' addressStreet: type: string addressCity: type: string addressPostalCode: type: string addressCountry: type: string required: - linkedIn - facebook - twitter - instagram - xing - phone - email - customLinks - addressStreet - addressCity - addressPostalCode - addressCountry MeetingTypeBasicResponseDto: type: object properties: meetingInfo: description: Meeting information (title, description, duration, etc.) allOf: - $ref: '#/components/schemas/MeetingInfo' spots: type: number description: Number of available spots for the meeting enabled: type: boolean description: Whether the meeting type is enabled slug: type: string description: Meeting type unique slug formId: type: string description: Form ID associated with the meeting type communicationSettingsId: type: number nullable: true description: Communication settings ID availabilityId: type: string description: Availability ID associated with the meeting type companyId: type: string description: Company ID that owns this meeting type queueId: type: string description: Queue ID if meeting type uses a queue locations: description: Available meeting locations type: array items: type: string workspaceId: type: string description: Workspace ID if meeting type belongs to a workspace isGlobalQueue: type: boolean description: Whether this meeting type uses a global queue userId: type: string description: User ID who owns this meeting type createdById: type: string description: User ID who created this meeting type createdAt: type: string description: Creation timestamp deletedAt: type: string description: Deletion timestamp if soft deleted resourceChannelIds: description: IDs of resource channels associated with this meeting type type: array items: type: string required: - meetingInfo - spots - enabled - slug - companyId - locations - isGlobalQueue - createdById - createdAt CalendarSyncProvider: type: string enum: - google - outlook - icloud - caldav - exchange - nextcloud - smart-we - salesforce CustomLink: type: object properties: name: type: string url: type: string icon: type: string required: - name - url - icon MeetingInfo: type: object properties: name: type: string description: Name of the meeting type description: type: string description: Description of the meeting type nameLocalised: nullable: true description: Per-language overrides for the title. Falls back to `name`. allOf: - $ref: '#/components/schemas/LocalisedContent' descriptionLocalised: nullable: true description: >- Per-language overrides for the description. Falls back to `description`. allOf: - $ref: '#/components/schemas/LocalisedContent' enableRedirect: type: boolean description: Enable redirect after booking completion redirect: type: string description: Redirect URL to navigate after booking passEventDetailsToRedirect: type: boolean description: >- Pass event details (invitee name, email, form answers) as query params to redirect URL duration: type: number description: Primary duration in minutes channel: description: Meeting channel/location type allOf: - $ref: '#/components/schemas/MeetingTypeChannel' customChannelName: type: string description: Custom name for the meeting channel customChannelLink: type: string description: Custom link for the meeting channel connectChannelName: type: string description: Custom display name for the connect channel groupBooking: type: boolean description: Enable group booking (multiple attendees per slot) showAvailableSlots: type: boolean description: Show available spots count on the booking page enrichInvitee: type: boolean description: Enable invitee data enrichment autoCreateSpace: type: boolean description: Auto-create a Space when someone books spacePresetId: type: object description: Space preset id used for the auto-created Space nullable: true spaceAutoInvite: type: boolean description: Publish the auto-created Space and invite the booker confirmationButton: description: Confirmation button settings allOf: - $ref: '#/components/schemas/ConfirmationButton' bufferBefore: type: number description: Buffer time before meeting in minutes bufferAfter: type: number description: Buffer time after meeting in minutes bufferMustStayWithinWorkingHours: type: boolean description: >- Only offer slots where buffer fits within working hours (no spillover into breaks or after-hours) rollingSlots: type: boolean description: >- Restart the slot grid after each appointment instead of keeping a fixed grid per working block color: type: object description: Color for the meeting type in RGB format, e.g. "rgb(0, 153, 255)" nullable: true required: - name - description - enableRedirect - redirect - passEventDetailsToRedirect - duration - channel - customChannelName - customChannelLink - connectChannelName - groupBooking - showAvailableSlots - enrichInvitee - autoCreateSpace - spaceAutoInvite - confirmationButton - bufferBefore - bufferAfter - bufferMustStayWithinWorkingHours - rollingSlots LocalisedContent: type: object properties: en: type: string de: type: string fr: type: string es: type: string 'no': type: string it: type: string nl: type: string da: type: string pl: type: string se: type: string tr: type: string required: - en MeetingTypeChannel: type: string enum: - local - local-attendee - google - zoom - phone - phone-incoming - whatsapp - connect - webex - skypeForConsumer - skypeForBusiness - teamsForBusiness - teamsForBusiness2 - teamsForExchange - teams2ForExchange - custom - resource - whereby - kmeet - zava - jitsi - nextcloudTalk - openTalk - alfaview description: Meeting channel/location type ConfirmationButton: type: object properties: useConfirmationButton: type: boolean text: type: string color: type: string link: type: string required: - useConfirmationButton - text - color - link responses: BadRequest: description: >- The request did not validate. `message` lists the constraints that failed. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Missing, malformed, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: >- Authenticated, but not allowed: the plan does not include this feature, or the token is scoped away from it. content: application/json: schema: $ref: '#/components/schemas/ApiError' TooManyRequests: description: Rate limited. Back off and retry. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiUserHeader: type: apiKey in: header name: x-meetergo-api-user-id description: >- User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user. JWT: scheme: bearer bearerFormat: JWT type: http description: JWT Bearer token for standard user authentication ApiKey: scheme: bearer bearerFormat: API Key type: http description: >- Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.