> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Search users > Search Alvys user accounts with paginated POST filters — name, email, role, subsidiary access, and enabled or disabled account status. The Search Users API endpoint allows users to search for specific user accounts within the Alvys system based on a keyword. This endpoint helps administrators efficiently find and manage user data by providing detailed information about users matching the search criteria. ### Request Parameters The following parameter is required in the URL path: | Parameter | Type | Required | Description | | --------- | ------ | -------- | --------------------------------------- | | version | String | Yes | The version of the API being requested. | #### Request Body The request body must include the following parameters: `` `
Parameter Type Required Description
Page Number Yes The page number for pagination.
PageSize Number Yes The number of results per page.\ PageSize must be greater than 0.
Keyword String No The keyword to search for in user data.
` #### Example CURL request Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v1/users/search' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' \ --header 'Content-Type: application/json' \ --data-raw '{ "Page": 0, "PageSize": 100, "Keyword": "" }' ``` ### Response Parameters The response contains a list of users matching the search criteria, each represented by the following parameters: | Parameter | Type | Description | | ----------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------- | | Page | Number | The current page number. | | PageSize | Number | The number of items per page. | | Total | Number | The total number of matching items. | | Items | Array | The list of users matching the search criteria. | | Items.Id | String | The unique identifier of the user. | | Items.UserName | String | The username of the user. | | Items.Name | String | The full name of the user. | | Items.Email | String | The email address of the user. | | Items.UserType | String | The type of user (e.g., Internal, External). | | Items.Role | String | The role assigned to the user (e.g., Admin, Dispatcher, Driver, Biller, SalesAgent, DataEntry, Safety, OperationManager). | | Items.Phone | String | The phone number of the user. | | Items.CompanyCode | String | The code of the company the user is associated with. | | Items.Status | String | The current status of the user (e.g., Active, Disabled, Deleted). | | Items.Permissions | Array of Strings | A list of permissions assigned to the user. | | Items.CreatedAt | String (Date-Time) | The date and time when the user was created. | | Items.ModifiedAt | String (Date-Time) | The date and time when the user's details were last modified. | #### Example Response On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code. #### Rate Limits All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the [Rate Limits](/docs/rate-limits) section. This page is interactive, allowing you to try a request by completing the fields for the parameters below. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request. ## OpenAPI ````yaml POST /api/p/v{version}/users/search openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/users/search: post: tags: - Users summary: Search users parameters: - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserSearchRequest' application/json: schema: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserSearchRequest' text/json: schema: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserSearchRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserSearchRequest' responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Alvys.Helpers.PagedResponse1Alvys.Models.Users.UserDto '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Users.UserSearchRequest: required: - Page - PageSize type: object properties: Page: type: integer format: int32 PageSize: type: integer format: int32 Keyword: type: string nullable: true additionalProperties: false Alvys.Helpers.PagedResponse1Alvys.Models.Users.UserDto: required: - Items - Page - PageSize - Total type: object properties: Page: type: integer format: int32 PageSize: type: integer format: int32 Facets: type: object additionalProperties: type: array items: $ref: '#/components/schemas/Alvys.Helpers.ResultSetFacetItem' nullable: true Total: type: integer format: int64 Items: type: array items: $ref: '#/components/schemas/Alvys.Models.Users.UserDto' additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Helpers.ResultSetFacetItem: required: - Count - Value type: object properties: Value: type: string Count: type: integer format: int64 additionalProperties: false Alvys.Models.Users.UserDto: required: - CompanyCode - Id - Name - Permissions - Role - Status - UserName - UserType type: object properties: Id: type: string UserName: type: string Name: type: string Email: type: string nullable: true UserType: type: string Role: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserDtoUserRole' Phone: type: string nullable: true CompanyCode: type: string Status: allOf: - $ref: '#/components/schemas/Alvys.Models.Users.UserDtoUserStatus' Permissions: type: array items: type: string CreatedAt: type: string format: date-time nullable: true ModifiedAt: type: string format: date-time nullable: true additionalProperties: false Alvys.Models.Users.UserDtoUserRole: enum: - Admin - Dispatcher - Driver - Biller - SalesAgent - DataEntry - Safety - OperationManager type: string Alvys.Models.Users.UserDtoUserStatus: enum: - Active - Disabled - Deleted type: string securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````