> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryFunctionMethods # Package: functions # Namespace: FunctionMethods # Method link: https://dev.wix.com/docs/api-reference/business-management/functions/function-methods/query-function-methods.md ## Permission Scopes: Manage Functions: SCOPE.DC-FUNCTIONS.MANAGE-FUNCTIONS ## Introduction Retrieves a list of function methods, given the provided paging, filtering, and sorting. Query Function Methods runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query function methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/get-started/api-query-language.md). --- ## REST API ### Schema ``` Method: queryFunctionMethods Description: Retrieves a list of function methods, given the provided paging, filtering, and sorting. Query Function Methods runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query function methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/get-started/api-query-language.md). URL: https://www.wixapis.com/functions/v1/function-methods/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. | validation: minimum 0, maximum 100, format int32 - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. | validation: maxLength 16000 - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` | validation: maxItems 5 - name: fieldName | type: string | description: Name of the field to sort by. | validation: maxLength 512 - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Query fields: - field: id | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined - field: functionId | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined - field: automationId | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined Return type: QueryFunctionMethodsResponse - name: functionMethods | type: array | description: List of function methods matching the query. - name: id | type: string | description: Function method GUID. | validation: format GUID - name: revision | type: string | description: Function method revision. | validation: format int64 - name: createdDate | type: string | description: Date and time the function method was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the function method was last updated. | validation: format date-time - name: automationId | type: string | description: GUID of the automation to link to the function. | validation: format GUID - name: functionId | type: string | description: GUID of the function that this method links to an automation. | validation: format GUID - name: methodName | type: string | description: Display name for the function method. | validation: maxLength 160 - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. | validation: format int32 - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. | validation: maxLength 16000 - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. | validation: maxLength 16000 - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query Function methods ```curl curl --request POST \ https://www.wixapis.com/functions/v1/methods/query \ --header "Content-Type: application/json" \ --header "Authorization: " \ --data '{ "query": { "filter": {} } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.functions.FunctionMethods.queryFunctionMethods(query) Description: Retrieves a list of function methods, given the provided paging, filtering, and sorting. Query Function Methods runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query function methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/get-started/api-query-language.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: FunctionMethodQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. | validation: minimum 0, maximum 100, format int32 - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. | validation: maxLength 16000 - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` | validation: maxItems 5 - name: fieldName | type: string | description: Name of the field to sort by. | validation: maxLength 512 - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Query fields: - field: _id | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined - field: functionId | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined - field: automationId | operators: $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined Return type: PROMISE - name: functionMethods | type: array | description: List of function methods matching the query. - name: _id | type: string | description: Function method GUID. | validation: format GUID - name: revision | type: string | description: Function method revision. | validation: format int64 - name: _createdDate | type: Date | description: Date and time the function method was created. - name: _updatedDate | type: Date | description: Date and time the function method was last updated. - name: automationId | type: string | description: GUID of the automation to link to the function. | validation: format GUID - name: functionId | type: string | description: GUID of the function that this method links to an automation. | validation: format GUID - name: methodName | type: string | description: Display name for the function method. | validation: maxLength 160 - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. | validation: format int32 - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. | validation: maxLength 16000 - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. | validation: maxLength 16000 - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryFunctionMethods ```javascript import { functionMethods } from '@wix/functions'; async function queryFunctionMethods(query) { const response = await functionMethods.queryFunctionMethods(query); }; ``` ### queryFunctionMethods (with elevated permissions) ```javascript import { functionMethods } from '@wix/functions'; import { auth } from '@wix/essentials'; async function myQueryFunctionMethodsMethod(query) { const elevatedQueryFunctionMethods = auth.elevate(functionMethods.queryFunctionMethods); const response = await elevatedQueryFunctionMethods(query); } ``` ### queryFunctionMethods (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { functionMethods } from '@wix/functions'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { functionMethods }, // Include the auth strategy and host as relevant }); async function queryFunctionMethods(query) { const response = await myWixClient.functionMethods.queryFunctionMethods(query); }; ``` ---