---
title: "UserCollection"
url: "https://api-docs.centraldispatch.com/apis/membership-api-1-0-0/versions/565f78cb-7a6d-42ef-bd8b-1af2d1394eef/schemas/UserCollection"
---

> Full API specification: https://api-docs.centraldispatch.com/apis/membership-api-1-0-0/versions/565f78cb-7a6d-42ef-bd8b-1af2d1394eef.md

# UserCollection

A paginated collection of users.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Membership API
  version: 1.0.0
servers:
  - url: https://membership-api.centraldispatch.com
    description: Production server
components:
  schemas:
    UserResponse:
      type: object
      properties:
        href:
          type: string
          description: The fully qualified URL of the user record.
          example: https://membership-api.centraldispatch.com/users/id/d71b5750-e89b-12d3-a456-426614174000
        userId:
          type: string
          description: The ID of the user.
          format: uuid
          example: d71b5750-e89b-12d3-a456-426614174000
        firstName:
          type: string
          description: The preferred first name of the user.
          nullable: true
          example: Mickey
        lastName:
          type: string
          description: The legal last name of the user.
          example: Smith
        legalFirstName:
          type: string
          description: The legal first name of the user.
          example: Michael
        emailAddress:
          type: string
          description: The email address of the user.
          nullable: true
          example: mickey@snoogle.com
        username:
          type: string
          description: The username of the user.
          example: msmith
        isActive:
          type: boolean
          description: Indicates if the user is active.
          example: true
        createdOn:
          type: string
          description: The creation date of the user (UTC/ISO 8601).
          format: date-time
          example: 2024-10-31T00:00:00Z
        updatedOn:
          type: string
          description: The last updated date of the user (UTC/ISO 8601).
          format: date-time
          example: 2024-10-15T00:00:00Z
        phoneNumber:
          type: string
          description: The phone number of the user.
          nullable: true
          example: 949-555-1323
      description: A user record.
    UserCollection:
      type: object
      properties:
        href:
          type: string
          description: The URL used to query the current collection of the resource.
          example: https://membership-api.centraldispatch.com/users/mine?limit(5,1)
        items:
          type: array
          items:
            $ref: "#/components/schemas/UserResponse"
          description: A collection of records.
        limit:
          type: integer
          description: The maximum number of items to be returned in the response.
          format: int32
          example: 1
        next:
          type: string
          description: The URL to the next page of the collection, if available.
          nullable: true
          example: https://membership-api.centraldispatch.com/users/mine?limit(6,1)
        previous:
          type: string
          description: The URL to the previous page of the collection, if available.
          nullable: true
          example: https://membership-api.centraldispatch.com/users/mine?limit(4,1)
        first:
          type: string
          description: The URL to the first page of the collection.
          nullable: true
          example: https://membership-api.centraldispatch.com/users/mine?limit(1,1)
        count:
          type: integer
          description: The total count of resources in the collection.
          format: int32
          example: 23
      description: A paginated collection of users.
```