---
title: "Portal Search"
url: "https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/2775d480-6d49-4d32-a9b4-5a43edc6cc32"
---

# Portal Search

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal Search","version":"3.0.4","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v3/search":{"get":{"operationId":"search-portal","summary":"List Portal Entities via Search","description":"Returns paginated search results for all entities with the given search parameters.","parameters":[{"$ref":"#/components/parameters/PortalSearchQuery"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/PortalSearchResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"portalAccessToken":[]},{}],"tags":["Search"]}}},"components":{"parameters":{"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"PortalSearchQuery":{"name":"q","description":"Determines how to filter search results","required":false,"in":"query","schema":{"$ref":"#/components/schemas/PortalSearchQueryParameters"}}},"schemas":{"PortalSearchResults":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"description":"The paginated results that matched the search query","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PortalSearchResultOperation"},{"$ref":"#/components/schemas/PortalSearchResultDocument"}]}}},"additionalProperties":false,"required":["data","meta"],"title":"SearchResults"},"PortalSearchResultOperation":{"type":"object","properties":{"id":{"description":"Unique identifier for the record.","type":"string"},"type":{"description":"Portal entity type.","type":"string"},"name":{"description":"Name of the entity.","type":"string"},"match":{"description":"The matched text from the record.","type":"string"},"description":{"description":"Description of the entity.","type":"string"},"attributes":{"description":"Attributes for the entity.","type":"object","additionalProperties":false,"properties":{"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"operation_id":{"description":"The operation ID of the operation.","type":"string"},"operation_key":{"description":"The operation key of the operation.","type":"string"},"path":{"description":"The path of the operation.","type":"string"},"method":{"description":"The method of the operation.","type":"string"},"scope":{"description":"The scope of the operation.","type":"string"},"summary":{"description":"The summary of the operation.","type":"string"},"api_description":{"description":"The description of the API.","type":"string"},"api_name":{"description":"The name of the API.","type":"string"},"api_slug":{"description":"The URL slug of the API.","type":"string"},"api_version":{"description":"The version of the API.","type":"string"}},"required":["created_at","updated_at","operation_id","operation_key","path","method","scope","summary","api_description","api_name","api_slug","api_version"]},"relations":{"description":"Relations for the entity.","type":"object","additionalProperties":false,"properties":{"api_id":{"description":"The ID of the API.","type":"string"},"spec_id":{"description":"The ID of the API specification.","type":"string"},"portal_id":{"description":"The ID of the portal.","type":"string"},"org_id":{"description":"The ID of the organization.","type":"string"},"api_name":{"description":"The name of the API.","type":"string"},"api_slug":{"description":"The slug of the API.","type":"string"},"api_version":{"description":"The version of the API.","type":"string"},"api_description":{"description":"The description of the API.","type":"string"}},"required":["api_id","spec_id","portal_id","org_id","api_name","api_slug","api_version","api_description"]}},"additionalProperties":false,"required":["id","type","name","match","description","attributes","relations"],"title":"SearchResultOperation"},"PortalSearchResultDocument":{"type":"object","properties":{"id":{"description":"Unique identifier for the record.","type":"string"},"type":{"description":"Portal entity type.","type":"string"},"name":{"description":"Name of the entity.","type":"string"},"match":{"description":"The matched text from the record.","type":"string"},"description":{"description":"Description of the entity.","type":"string"},"attributes":{"description":"Attributes for the entity.","type":"object","additionalProperties":false,"properties":{"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"path":{"description":"The path of the operation.","type":"string"},"scope":{"description":"The scope of the operation.","type":"string"},"api_slug":{"description":"The URL slug of the API.","type":"string"},"parent_document_id":{"description":"The ID of the parent document if one exists.","type":"string"},"slug":{"description":"The URL slug of the document.","type":"string"}},"required":["created_at","updated_at","path","scope","api_slug","parent_document_id","slug"]},"relations":{"description":"Relations for the entity.","type":"object","additionalProperties":false,"properties":{"api_id":{"description":"The ID of the API.","type":"string"},"spec_id":{"description":"The ID of the API specification.","type":"string"},"portal_id":{"description":"The ID of the portal.","type":"string"},"org_id":{"description":"The ID of the organization.","type":"string"},"api_slug":{"description":"The slug of the API.","type":"string"},"api_version":{"description":"The version of the API.","type":"string"},"api_description":{"description":"The description of the API.","type":"string"},"parent_document_id":{"description":"The ID of the parent document if one exists.","type":"string"},"path":{"description":"The path of the document.","type":"string"},"slug":{"description":"The URL slug of the document.","type":"string"}},"required":["api_id","spec_id","portal_id","org_id","api_slug","api_version","api_description","parent_document_id","path","slug"]}},"additionalProperties":false,"required":["id","type","name","match","description","attributes","relations"],"title":"SearchResultDocument"},"PortalSearchQueryParameters":{"type":"string","title":"SearchQueryParameters"},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]}},"examples":{"PortalSearchResponseOperationExample":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","type":"api_specs_operation","name":"Get Users","description":"Returns a list of users.","match":"a string","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.","scope":"private","api_name":"Users API","api_slug":"users-api-v1","api_version":"1.0.0","api_description":"API used to manage 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."}}],"meta":{"page":{"previous":null,"next":"/api/v3/search?page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ","size":1}}}},"PortalSearchResponseDocumentExample":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","type":"api_document","name":"my-document","description":"my document","match":"a string","attributes":{"created_at":"2023-01-19T17:41:55.896Z","updated_at":"2023-01-19T17:41:55.896Z","path":"/my-document","scope":"private","api_slug":"my-api","parent_document_id":"49fd316e-c457-481c-9fc7-8079153e4f3c","slug":"my-document"},"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_slug":"my-api","api_version":"3.0.1","api_description":"My API.","parent_document_id":"49fd316e-c457-481c-9fc7-8079153e4f3c","path":"/my-document","slug":"my-document"}}],"meta":{"page":{"previous":null,"next":"/api/v3/search?page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ","size":1}}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}}},"responses":{"PortalSearchResponse":{"description":"Search Results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSearchResults"},"examples":{"Search Response Operation Example":{"$ref":"#/components/examples/PortalSearchResponseOperationExample"},"Search Response Document Example":{"$ref":"#/components/examples/PortalSearchResponseDocumentExample"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"Search","description":"The API for Konnect Portal Search."}]}
```
