---
agentTools:
  projectIndex: https://nudgesecurity.readme.io/llms.txt
---

# Search apps

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "App": {
        "properties": {
          "account_count": {
            "nullable": true,
            "type": "integer"
          },
          "adoption_percentage": {
            "nullable": true,
            "type": "integer"
          },
          "category": {
            "readOnly": true,
            "type": "string"
          },
          "counters": {
            "$ref": "#/components/schemas/SaasCounter"
          },
          "domain_canonical": {
            "nullable": true,
            "type": "string"
          },
          "fields": {
            "readOnly": true,
            "type": "array"
          },
          "first_date": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "is_ignored": {
            "nullable": true,
            "type": "boolean"
          },
          "labels": {
            "readOnly": true,
            "type": "array"
          },
          "last_activity": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "residual_risk_score": {
            "readOnly": true,
            "type": "object"
          },
          "service_info": {
            "$ref": "#/components/schemas/ServiceInfo"
          },
          "supports_sso": {
            "readOnly": true,
            "type": "boolean"
          },
          "technical_contact_group_id": {
            "readOnly": true,
            "type": "integer"
          },
          "technical_contact_id": {
            "readOnly": true,
            "type": "integer"
          },
          "technical_contact_origin": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "AppsFilterRequest": {
        "properties": {
          "field_name": {
            "default": null,
            "description": "Field name to use in the condition. Only used when the property is 'fields'",
            "nullable": true,
            "type": "string"
          },
          "op": {
            "description": "Operation to apply over the field",
            "enum": [
              "=",
              "!=",
              "<",
              "<=",
              ">",
              ">=",
              "like",
              "ilike",
              "not_like",
              "not_ilike",
              "in",
              "notin",
              "notnull",
              "isnull"
            ],
            "type": "string"
          },
          "property": {
            "description": "Property to use in the condition",
            "enum": [
              "id",
              "name",
              "domain_canonical",
              "account_count",
              "adoption_percentage",
              "first_date",
              "fields",
              "service_info.name",
              "technical_contact_id",
              "technical_contact.name",
              "category",
              "is_ignored",
              "residual_risk_score"
            ],
            "type": "string"
          },
          "value": {
            "default": null,
            "description": "Depending on the operation and the field, the value can be a string, an integer, a boolean, or a list of strings or integers",
            "nullable": true
          }
        },
        "required": [
          "op",
          "property"
        ],
        "type": "object"
      },
      "AppsPage": {
        "properties": {
          "next_page": {
            "default": null,
            "nullable": true,
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "per_page": {
            "type": "integer"
          },
          "prev_page": {
            "default": null,
            "nullable": true,
            "type": "integer"
          },
          "total_pages": {
            "type": "integer"
          },
          "total_values": {
            "type": "integer"
          },
          "values": {
            "items": {
              "$ref": "#/components/schemas/App"
            },
            "type": "array"
          }
        },
        "required": [
          "page",
          "per_page",
          "total_pages",
          "total_values"
        ],
        "type": "object"
      },
      "AppsPageRequest": {
        "properties": {
          "filters": {
            "description": "List conditions to filter on",
            "items": {
              "$ref": "#/components/schemas/AppsFilterRequest"
            },
            "maxItems": 10,
            "type": "array"
          },
          "page": {
            "default": 1,
            "description": "Page number to retrieve",
            "minimum": 1,
            "type": "integer"
          },
          "per_page": {
            "default": 10,
            "description": "Number of items per page to retrieve. Defaults to a maximum of 100; some organizations may be allowed a higher limit up to 2500",
            "maximum": 2500,
            "minimum": 0,
            "type": "integer"
          },
          "search": {
            "description": "List of conditions to search for. Multiple conditions are combined with an OR",
            "items": {
              "$ref": "#/components/schemas/AppsFilterRequest"
            },
            "maxItems": 10,
            "type": "array"
          },
          "sorting": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AppsSortRequest"
              }
            ],
            "default": null,
            "description": "Sorting to apply on the results",
            "nullable": true
          }
        },
        "type": "object"
      },
      "AppsSortRequest": {
        "properties": {
          "direction": {
            "default": "asc",
            "enum": [
              "asc",
              "desc"
            ],
            "type": "string"
          },
          "property": {
            "description": "Property to use in the sort condition",
            "enum": [
              "id",
              "name",
              "domain_canonical",
              "account_count",
              "adoption_percentage",
              "first_date"
            ],
            "type": "string"
          }
        },
        "required": [
          "property"
        ],
        "type": "object"
      },
      "HTTPError": {
        "properties": {
          "detail": {
            "type": "object"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "SaasCounter": {
        "properties": {
          "total_accounts": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "ServiceInfo": {
        "properties": {
          "category": {
            "$ref": "#/components/schemas/ServiceInfoCategory"
          },
          "icon_url": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "service_canonical_domain": {
            "type": "string"
          },
          "service_description": {
            "nullable": true,
            "type": "string"
          },
          "status_page": {
            "$ref": "#/components/schemas/ServiceInfoStatusPage"
          },
          "title": {
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "service_canonical_domain"
        ],
        "type": "object"
      },
      "ServiceInfoCategory": {
        "properties": {
          "description": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "ServiceInfoStatusPage": {
        "properties": {
          "status_indicator": {
            "nullable": true,
            "type": "string"
          },
          "status_page_domain": {
            "type": "string"
          }
        },
        "required": [
          "status_page_domain"
        ],
        "type": "object"
      },
      "ValidationError": {
        "properties": {
          "detail": {
            "properties": {
              "<location>": {
                "properties": {
                  "<field_name>": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            },
            "type": "object"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "description": "Authorization header containing the Nudge API Token",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Nudge API",
    "version": "1.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/api/1.0/apps/search": {
      "post": {
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppsPageRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppsPage"
                }
              }
            },
            "description": "Successful response"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationError"
                }
              }
            },
            "description": "Validation error"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Authentication error"
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "summary": "Search apps",
        "tags": [
          "Apps"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.nudgesecurity.io"
    }
  ],
  "tags": [
    {
      "name": "Apps"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 130,
      "2": 205,
      "3": 225,
      "4": 131,
      "5": 178,
      "6": 81,
      "7": 0,
      "8": 15,
      "9": 104,
      "10": 80,
      "11": 14
    }
  }
}
```