Skip to main content
GET
/
v4
/
user
List users
curl --request GET \
  --url https://api.example.com/v4/user \
  --header 'x-meetergo-api-user-id: <api-key>'
{
  "users": [
    {
      "id": "<string>",
      "isAdmin": true,
      "isScimDisabled": true,
      "familyName": "<string>",
      "givenName": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "title": "<string>",
      "anonymousBooking": true,
      "anonymousCalendarActivity": true,
      "slug": "<string>",
      "showGettingStartedList": true,
      "recieveEmailMarketing": true,
      "timezone": "<string>",
      "language": "en",
      "personalPage": {
        "useCustomColors": true,
        "primaryColor": "<string>",
        "secondaryColor": "<string>",
        "description": "<string>",
        "onlineProfiles": {
          "linkedIn": "<string>",
          "facebook": "<string>",
          "twitter": "<string>",
          "instagram": "<string>",
          "xing": "<string>",
          "phone": "<string>",
          "email": "<string>",
          "customLinks": [
            {
              "name": "<string>",
              "url": "<string>",
              "icon": "<string>"
            }
          ]
        },
        "headerImage": "<string>",
        "meetingTypes": [
          {
            "meetingInfo": {
              "name": "<string>",
              "description": "<string>",
              "enableRedirect": true,
              "redirect": "<string>",
              "duration": 123,
              "channel": "local",
              "customChannelName": "<string>",
              "customChannelLink": "<string>",
              "groupBooking": true,
              "enrichInvitee": true,
              "confirmationButton": {
                "useConfirmationButton": true,
                "text": "<string>",
                "color": "<string>",
                "link": "<string>"
              },
              "bufferBefore": 123,
              "bufferAfter": 123,
              "color": {}
            },
            "spots": 123,
            "enabled": true,
            "slug": "<string>",
            "companyId": "<string>",
            "locations": [
              "<string>"
            ],
            "isGlobalQueue": true,
            "createdById": "<string>",
            "createdAt": "<string>",
            "formId": "<string>",
            "communicationSettingsId": 123,
            "availabilityId": "<string>",
            "queueId": "<string>",
            "workspaceId": "<string>",
            "userId": "<string>",
            "deletedAt": "<string>",
            "resourceChannelIds": [
              "<string>"
            ]
          }
        ]
      },
      "userType": "standard",
      "fullName": "<string>",
      "companyId": "<string>",
      "email": "<string>",
      "picture": "<string>",
      "deletedAt": "<string>",
      "referralId": "<string>",
      "calendarSyncProviders": {
        "id": "<string>",
        "type": "google"
      },
      "defaultAvailabilityId": "<string>",
      "aircallUserId": "<string>",
      "phone": "<string>",
      "wherebyApiKey": "<string>",
      "groupIds": [
        "<string>"
      ],
      "groupAdminIds": [
        "<string>"
      ],
      "meetingTypeIds": [
        "<string>"
      ],
      "meetingTypeTemplateIds": [
        "<string>"
      ],
      "appointmentIds": [
        "<string>"
      ],
      "workspaceIds": [
        "<string>"
      ],
      "reminderIds": [
        "<string>"
      ],
      "formIds": [
        "<string>"
      ],
      "dealIds": [
        "<string>"
      ],
      "queueIds": [
        "<string>"
      ],
      "queueUserGroupIds": [
        "<string>"
      ],
      "availabilityIds": [
        "<string>"
      ],
      "company": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "timezone": "<string>",
        "language": "<string>",
        "logo": "<string>",
        "description": "<string>"
      }
    }
  ],
  "total": 25,
  "count": 10,
  "offset": 0
}

Authorizations

​
x-meetergo-api-user-id
string
header
required

User ID to act as when using API Key authentication (required with API Key)

Query Parameters

​
userType
enum<string>

Filter users by type. If not specified, returns all user types.

Available options:
standard,
resource,
api-platform
​
limit
number
default:50

Maximum number of users to return

Required range: 1 <= x <= 100
Example:

20

​
offset
number
default:0

Number of users to skip for pagination

Required range: x >= 0
Example:

0

Response

200 - application/json

Users retrieved successfully

​
users
object[]
required

Array of users matching the query criteria

​
total
number
required

Total number of users matching the query criteria (before pagination)

Required range: x >= 0
Example:

25

​
count
number
required

Number of users returned in this response

Required range: x >= 0
Example:

10

​
offset
number
required

Number of users skipped (pagination offset)

Required range: x >= 0
Example:

0