Download OpenAPI specification:Download
N/A (this description is removed during bundling)
Pre-release Endpoint This endpoint is currently in beta and is subject to change.
Returns paginated search results for all entities with the given search parameters.
| q | string (SearchQueryParameters) Determines how to filter search results |
| page[size] | integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items. |
| page[after] | string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter. |
{- "data": [
- {
- "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
- "type": "operation",
- "name": "Get Users",
- "description": "Returns a list of users.",
- "attributes": {
- "created_at": "2023-01-19T17:41:55.896Z",
- "updated_at": "2023-01-19T17:41:55.896Z",
- "operation_id": "listUsersV1",
- "operation_key": "GET /users",
- "path": "/users",
- "method": "GET",
- "summary": "Returns a list of users."
}, - "relations": {
- "api_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "spec_id": "7710d5c4-d902-410b-992f-18b814155b53",
- "portal_id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
- "org_id": "ebbac5b0-ac89-45c3-9d2e-c4542c657e79",
- "api_name": "Users API",
- "api_slug": "users-api-v1",
- "api_version": "1.0.0",
- "api_description": "API used to manage users."
}, - "labels": {
- "status": "published",
- "version": "1.0.0"
}
}
], - "meta": {
- "page": {
- "previous": null,
- "next": "/api/v3/search?page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ",
- "size": 1
}
}
}