> ## Documentation Index > Fetch the complete documentation index at: https://docs.light.inc/llms.txt > Use this file to discover all available pages before exploring further. # List users > Returns a paginated list of users ## OpenAPI ````yaml /openapi-public.json get /v1/users openapi: 3.0.1 info: title: Light API version: 1.0.0 servers: [] security: - apiKeyAuth: [] - bearerAuth: [] paths: /v1/users: get: tags: - v1 - Users summary: List users description: Returns a paginated list of users operationId: listUsers parameters: - name: sort in: query schema: type: string description: >- Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `firstName`, `lastName`, `status`, `createdAt`, `updatedAt`. example: amount:desc,createdAt:asc - name: filter in: query schema: type: string description: >- Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `id`, `userGroupId`, `status`, `email`, `createdAt`, `updatedAt`, `role`, `assignedRole`. example: state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null - name: limit in: query schema: maximum: 200 type: integer format: int32 - name: offset in: query description: >- Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead. deprecated: true schema: type: integer format: int64 - name: cursor in: query description: >- The cursor position to start returning results from. To opt-in into cursor-based pagination, provide `0` for the initial request. For subsequent requests, use `nextCursor` and `prevCursor` from the previous response to navigate. Cursor values are opaque and should not be constructed manually. schema: type: string - name: includeRoles in: query schema: type: boolean - name: includeGroups in: query schema: type: boolean - name: includeManagers in: query schema: type: boolean responses: default: description: default response content: application/json;charset=UTF-8: schema: $ref: >- #/components/schemas/ExternalPaginatedResponseV1ModelExternalUserV1Model components: schemas: ExternalPaginatedResponseV1ModelExternalUserV1Model: type: object properties: records: type: array description: List of records for the current page items: $ref: '#/components/schemas/ExternalUserV1Model' hasMore: type: boolean description: Boolean flag indicating if there are more records available total: type: integer description: >- Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination. format: int64 nullable: true deprecated: true nextCursor: type: string description: Cursor for fetching the next page (only for cursor pagination) nullable: true prevCursor: type: string description: Cursor for fetching the previous page (only for cursor pagination) nullable: true ExternalUserV1Model: type: object properties: id: type: string format: uuid companyId: type: string format: uuid companyEntityId: type: string format: uuid email: type: string firstName: type: string lastName: type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' avatarUrl: type: string notificationChannel: type: string description: >- ⚠️ This enum is not exhaustive; new values may be added in the future. enum: - MS_TEAMS - SLACK - WEB_APP country: type: string description: >- ⚠️ This enum is not exhaustive; new values may be added in the future. enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW city: type: string zipcode: type: string address: type: string status: type: string description: >- ⚠️ This enum is not exhaustive; new values may be added in the future. enum: - ACTIVE - DEACTIVATED createdAt: type: string format: date-time updatedAt: type: string format: date-time roles: uniqueItems: true type: array items: type: string description: >- ⚠️ This enum is not exhaustive; new values may be added in the future. enum: - SUPERUSER - REIMBURSEMENT - CARDHOLDER - CONTROLLER - COMPANY_ADMIN - VENDOR_MANAGEMENT - INVOICE_APPROVER - AP_PREPARATION - AP_CLERK - AR_CLERK - PURCHASE_REQUESTER - REPORT_VIEWER - AUDITOR groups: uniqueItems: true type: array items: $ref: '#/components/schemas/ExternalUserGroupV1Model' managerIds: uniqueItems: true type: array items: type: string format: uuid PhoneNumber: type: object properties: countryCode: type: string description: >- ⚠️ This enum is not exhaustive; new values may be added in the future. enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW localNumber: type: string description: Vendor phone number. nullable: true ExternalUserGroupV1Model: type: object properties: id: type: string format: uuid name: type: string description: type: string companyId: type: string format: uuid memberCount: type: integer format: int64 createdAt: type: string format: date-time updatedAt: type: string format: date-time securitySchemes: apiKeyAuth: type: apiKey description: >- Basic authentication header of the form **Basic** ****, where **** is your api key. name: Authorization in: header bearerAuth: type: http scheme: bearer bearerFormat: JWT ````