# List all offers

**GET /v1/Offers**

Returns a list the offers in the tenant. The offers are returned sorted by SortPropertyName. If a customer is not provided in the query params the offer prices will not be scoped to one market. To view the offer prices for a certain customer/market provide the desired customer.


## Servers
- https://api.cloudcockpit.com: https://api.cloudcockpit.com ()


## Authentication methods
- Bearer auth


## Parameters
### Headers
- **X-Tenant** (string)
  The domain used to access the portal.
- **Authorization** (string)
  JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
- **X-Correlation-Id** (string(uuid))
  This header is optional and by setting it you can correlate the audit logs made by this request.


### Query parameters
- **PageNumber** (integer(int32))
  A cursor for pagination across multiple pages of results. The default value is 1.
- **PageSize** (integer(int32))
  The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.
- **SortPropertyName** (string)
  The name of the property to sort the customers by. Possible values: Name
- **AscendingOrder** (boolean)
  The value indicating whether to sort in ascending order. If set to `true` [ascending order].
- **OfferTypes** (string)
  A string containing the OfferTypes to filter by. This string is a list separated by |. ex: License|AzurePlan
- **ProviderInstanceId** (string(uuid))
  The GUID identifier for the provider instance.
- **SearchValue** (string)
  The search query string.
- **SearchField** (string)
  The field to search in. Possible values: Name or ProviderOfferId
- **Segment** (string)
  The string indicating which segment to get the offers from. Possible values: Commercial, Education, Government or NonProfit
- **CustomerId** (string(uuid))
  GUID Unique identifier for the customer. If none is set the offers prices will no be scoped to one market, for normal use set this property. When the user is a customer this property will be auto-populated.
- **ResellerId** (string(uuid))
  GUID Unique identifier for the reseller. When this property is set the offer prices will have the corresponding margins applied. Only usable for CSPs.
- **IncludeDeleted** (boolean)
  The value indicating whether to include deleted offers in the offers list. Deprecated offers will also appear as deleted in the list.


## Responses
### 200
OK

#### Body: application/json (object)
- **items** (array[object] | null)
  The items for this page.
- **paginationParameters** (object)
  A model that is used to encapsulate the parameters needed to perform pagination queries.
- **totalPages** (integer(int32))
  The total number of pages available for the specified parameters and page size.
- **totalCount** (integer(int32))
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- **hasPreviousPage** (boolean)
  Indicates if there is a previous page.
- **hasNextPage** (boolean)
  Indicates if there is a next page.
- **continuationToken** (string | null)
  The token to continue to retrieve the paginated items.

### 400
Bad Request

#### Body: application/json (object)
- **statusCode** (integer(int32))
  The HTTP status code that represents a specific error scenario.
- **type** (string | null)
  The type of error that occurred.
- **description** (string | null)
  Describes the error scenario that occurred.
- **correlationId** (string | null)
  The correlationId of the request that originated the error.
- **errors** (array[object] | null)
  A list containing the detail of the errors that occurred in this error scenario.

### 401
Unauthorized

### 403
Forbidden

### 404
Not Found

#### Body: application/json (object)
- **statusCode** (integer(int32))
  The HTTP status code that represents a specific error scenario.
- **type** (string | null)
  The type of error that occurred.
- **description** (string | null)
  Describes the error scenario that occurred.
- **correlationId** (string | null)
  The correlationId of the request that originated the error.
- **errors** (array[object] | null)
  A list containing the detail of the errors that occurred in this error scenario.

### 500
Internal Server Error

#### Body: application/json (object)
- **statusCode** (integer(int32))
  The HTTP status code that represents a specific error scenario.
- **type** (string | null)
  The type of error that occurred.
- **description** (string | null)
  Describes the error scenario that occurred.
- **correlationId** (string | null)
  The correlationId of the request that originated the error.
- **errors** (array[object] | null)
  A list containing the detail of the errors that occurred in this error scenario.


[Powered by Bump.sh](https://bump.sh)