# Global search `GET /v2/search` Core API v2, Search. Search across payments, customers, subscriptions, and gateways. Results are filtered by the caller's permissions. **Authentication:** Send `Authorization: Bearer `. To authenticate, generate a Secret API Key from your ODUS Dashboard and include it in the `Authorization` header as follows: `Authorization: Bearer ` ## Parameters ### Query parameters - `q` (string, required): Search query string to find matching payments, customers, subscriptions, invoices, and prices. Minimum length 3. Example: `john@example.com`. ## Responses ### `200` OK Type: object (SearchResultsDTO). - `payments` (array of object, required): Matching payment results. - `id` (string, required): Unique identifier of the matched entity. Example: `pay_2abc3def4ghi5jkl`. - `label` (string, required): Primary identifier of the entity (e.g. customer email, payment ID) Example: `john@example.com`. - `sublabel` (string, required, nullable): Secondary context for the entity (e.g. customer name, payment amount) Example: `John Doe`. - `entityType` (string, required): The type of entity this search result represents. One of `payment`, `customer`, `subscription`, `invoice`, `price`. - `customers` (array of object, required): Matching customer results. - `id` (string, required): Unique identifier of the matched entity. Example: `pay_2abc3def4ghi5jkl`. - `label` (string, required): Primary identifier of the entity (e.g. customer email, payment ID) Example: `john@example.com`. - `sublabel` (string, required, nullable): Secondary context for the entity (e.g. customer name, payment amount) Example: `John Doe`. - `entityType` (string, required): The type of entity this search result represents. One of `payment`, `customer`, `subscription`, `invoice`, `price`. - `subscriptions` (array of object, required): Matching subscription results. - `id` (string, required): Unique identifier of the matched entity. Example: `pay_2abc3def4ghi5jkl`. - `label` (string, required): Primary identifier of the entity (e.g. customer email, payment ID) Example: `john@example.com`. - `sublabel` (string, required, nullable): Secondary context for the entity (e.g. customer name, payment amount) Example: `John Doe`. - `entityType` (string, required): The type of entity this search result represents. One of `payment`, `customer`, `subscription`, `invoice`, `price`. - `invoices` (array of object, required): Matching invoice results. - `id` (string, required): Unique identifier of the matched entity. Example: `pay_2abc3def4ghi5jkl`. - `label` (string, required): Primary identifier of the entity (e.g. customer email, payment ID) Example: `john@example.com`. - `sublabel` (string, required, nullable): Secondary context for the entity (e.g. customer name, payment amount) Example: `John Doe`. - `entityType` (string, required): The type of entity this search result represents. One of `payment`, `customer`, `subscription`, `invoice`, `price`. - `prices` (array of object, required): Matching price results. - `id` (string, required): Unique identifier of the matched entity. Example: `pay_2abc3def4ghi5jkl`. - `label` (string, required): Primary identifier of the entity (e.g. customer email, payment ID) Example: `john@example.com`. - `sublabel` (string, required, nullable): Secondary context for the entity (e.g. customer name, payment amount) Example: `John Doe`. - `entityType` (string, required): The type of entity this search result represents. One of `payment`, `customer`, `subscription`, `invoice`, `price`. ### `202` The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway. Type: object (ProvisioningInProgress). - `status` (string, required): Signals the merchant environment is still being provisioned. One of `provisioning`. - `merchantAccountId` (string, required): The merchant account whose environment is being provisioned. Example: `dAI3aa87ROOeupeBCjNSKCOBOisBCYjB`. ### Errors - `400`: The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; or `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it. - `401`: No API key was supplied, or the key is not valid. `type` is `authentication_error`. - `403`: The API key is valid but lacks the permission this operation requires. `type` is `permission_error`. - `429`: Too many requests. A limit applies per operation; requests to other operations are unaffected. `type` is `rate_limit_error`. Use the `Retry-After-global` header to know when to retry. - `500`: The request could not be completed because of an unexpected error. `type` is `api_error`. - `503`: The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. `type` is `api_error`. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff. - `504`: The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly. Every error response has the same body: see [Errors](https://docs.odus.com/docs/guides/api-features/errors.md). --- Generated from the Core API v2 OpenAPI document, https://api.odus.com/openapi.v2.json. Interactive page: https://docs.odus.com/docs/api/core/v2/search-controller-search