get: operationId: GetUsers summary: List Users description: >- Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. x-authenticated: true parameters: - name: fields in: query description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. required: false schema: type: number title: offset description: The number of items to skip when retrieving a list. externalDocs: url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. required: false schema: type: number title: limit description: Limit the number of items returned in the list. externalDocs: url: '#pagination' - name: order in: query description: >- The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. required: false schema: type: string title: order description: >- The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: q in: query description: The search term to filter the user's searchable properties. required: false schema: type: string title: q description: The search term to filter the user's searchable properties. - name: id in: query required: false schema: oneOf: - type: string title: id description: Filter by a user's ID. - type: array description: Filter by user IDs. items: type: string title: id description: A user's ID. - name: email in: query description: Filter by an email. required: false schema: type: string title: email description: Filter by an email. format: email - name: first_name in: query description: Filter by a first name. required: false schema: type: string title: first_name description: Filter by a first name. - name: last_name in: query description: Filter by a last name. required: false schema: type: string title: last_name description: Filter by a last name. - name: created_at in: query description: Filter by a user's creation date. required: false schema: type: object description: Filter by a user's creation date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by an exact match. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: >- Filter by values not matching the conditions in this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: type: string title: $not description: >- Filter by values not matching the conditions in this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: Filter arrays that have overlapping values with this parameter. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). title: created_at - name: updated_at in: query description: Filter by a user's update date. required: false schema: type: object description: Filter by a user's update date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by an exact match. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: >- Filter by values not matching the conditions in this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: type: string title: $not description: >- Filter by values not matching the conditions in this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: Filter arrays that have overlapping values with this parameter. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). title: updated_at - name: deleted_at in: query description: Filter by a user's deletion date. required: false schema: type: object description: Filter by a user's deletion date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by an exact match. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: >- Filter by values not matching the conditions in this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: type: string title: $not description: >- Filter by values not matching the conditions in this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: Filter arrays that have overlapping values with this parameter. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). title: deleted_at - name: with_deleted in: query description: Whether to include deleted records in the result. required: false schema: type: boolean title: with_deleted description: Whether to include deleted records in the result. x-codeSamples: - lang: JavaScript label: JS SDK source: $ref: ../code_samples/JavaScript/admin_users/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_users/get.sh tags: - Users responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminUserListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml security: - cookie_auth: [] - jwt_token: []