{
  "summary": "List offers",
  "description": "List of offers (not archived) for a site that can be granted to a contact\n## Pagination\nUse `page[number]` and `page[size]` parameters to paginate results:\n### Get first page of 10 items\n* `GET /v1/offers?page[number]=1&page[size]=10`\n### Get second page of 25 items\n* `GET /v1/offers?page[number]=2&page[size]=25`\n\nThe response includes pagination links and meta data:\n```json\n{\n  \"links\": {\n    \"self\": \"https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10\",\n    \"first\": \"https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10\",\n    \"prev\": \"https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10\",\n    \"next\": \"https://api.kajabi.com/v1/offers?page[number]=3&page[size]=10\",\n    \"last\": \"https://api.kajabi.com/v1/offers?page[number]=5&page[size]=10\"\n  },\n  \"meta\": {\n    \"total_pages\": 5,\n    \"total_count\": 50,\n    \"current_page\": 2\n  }\n}\n```\n## Sorting\nUse the `sort` parameter to sort the results:\n### Sort by title in ascending order\n* `GET /v1/offers?sort=title`\n### Sort by title in descending order\n* `GET /v1/offers?sort=-title`\n\nResponse will include offers sorted by the specified field\n```json\n{\n  \"data\": [\n    {\n      \"id\": \"123\",\n      \"type\": \"offers\",\n      \"attributes\": {\n        \"title\": \"Advanced Course Bundle\",\n        \"price_in_cents\": 19900,\n        \"status\": \"active\"\n      }\n    },\n    {\n      \"id\": \"456\",\n      \"type\": \"offers\",\n      \"attributes\": {\n        \"title\": \"Beginner Course Bundle\",\n        \"price_in_cents\": 9900,\n        \"status\": \"active\"\n      }\n    }\n  ]\n}\n```\n## Sparse Fields\nUse the `fields[offers]` parameter to request only specific attributes:\n### Only return title and price_in_cents attributes\n* `GET /v1/offers?fields[offers]=title,price_in_cents`\n\nResponse will only include requested fields\n```json\n{\n  \"data\": [{\n    \"id\": \"123\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Advanced Course Bundle\",\n      \"price_in_cents\": 19900\n    }\n  }]\n}\n```\n## Filter by Site ID\nUse the `filter[site_id]` parameter to get offers for a specific site:\n### Get offers for site with ID 123\n* `GET /v1/offers?filter[site_id]=123`\n\nResponse will only include offers for that site\n```json\n{\n  \"data\": [{\n    \"id\": \"456\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Advanced Course Bundle\",\n      \"price_in_cents\": 19900,\n      \"status\": \"active\"\n    },\n    \"relationships\": {\n      \"site\": {\n        \"data\": {\n          \"id\": \"123\",\n          \"type\": \"sites\"\n        }\n      }\n    }\n  }]\n}\n```\n## Filter by Title Contains\nUse the `filter[title_cont]` parameter to find offers where the title contains specific text:\n### Get offers with titles containing \"bundle\"\n* `GET /v1/offers?filter[title_cont]=bundle`\n\nResponse will include offers with matching titles\n```json\n{\n  \"data\": [{\n    \"id\": \"456\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Advanced Course Bundle\",\n      \"price_in_cents\": 19900,\n      \"status\": \"active\"\n    }\n  },\n  {\n    \"id\": \"789\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Basic Course Bundle\",\n      \"price_in_cents\": 9900,\n      \"status\": \"active\"\n    }\n  }]\n}\n```\n## Filter by Description Contains\nUse the `filter[description_cont]` parameter to find offers where the description contains specific text:\n### Get offers with descriptions containing \"marketing\"\n* `GET /v1/offers?filter[description_cont]=marketing`\n\nResponse will include offers with matching descriptions\n```json\n{\n  \"data\": [{\n    \"id\": \"456\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Marketing Course Bundle\",\n      \"description\": \"Complete marketing course bundle with advanced strategies\",\n      \"price_in_cents\": 19900,\n      \"status\": \"active\"\n    }\n  },\n  {\n    \"id\": \"789\",\n    \"type\": \"offers\",\n    \"attributes\": {\n      \"title\": \"Business Essentials\",\n      \"description\": \"Business fundamentals including marketing and sales\",\n      \"price_in_cents\": 9900,\n      \"status\": \"active\"\n    }\n  }]\n}\n```\n## Using Multiple Parameters Together\nYou can combine pagination, sorting, sparse fields and filtering in a single request:\n### Get page 2 of offers for site 123, sorted by price_in_cents descending, including only title and price_in_cents fields\n* `GET /v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents`\n\nResponse will include paginated and filtered offers with sparse fields\n```json\n{\n  \"data\": [\n    {\n      \"id\": \"456\",\n      \"type\": \"offers\",\n      \"attributes\": {\n        \"title\": \"Basic Course Bundle\",\n        \"price_in_cents\": 9900\n      },\n      \"relationships\": {\n        \"site\": {\n          \"data\": {\n            \"id\": \"123\",\n            \"type\": \"sites\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": \"https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents\",\n    \"first\": \"https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents\",\n    \"prev\": \"https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents\",\n    \"next\": null,\n    \"last\": \"https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents\"\n  },\n  \"meta\": {\n    \"total_pages\": 2,\n    \"total_count\": 15,\n    \"current_page\": 2\n  }\n}\n```\n",
  "method": "GET",
  "path": "/v1/offers",
  "tags": [
    "Offers"
  ],
  "parameters": [
    {
      "name": "sort",
      "in": "query",
      "required": false,
      "description": "Sort order, use: title, price_in_cents, for descending order use '-' e.g. &sort=-price_in_cents",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page[number]",
      "in": "query",
      "required": false,
      "schema": {
        "type": "number"
      }
    },
    {
      "name": "page[size]",
      "in": "query",
      "required": false,
      "description": "Number of documents",
      "schema": {
        "type": "number"
      }
    },
    {
      "name": "fields[offers]",
      "in": "query",
      "required": false,
      "description": "Partial attributes as specified, e.g. fields[offers]=title,price_in_cents",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter[site_id]",
      "in": "query",
      "required": false,
      "description": "Filter by site_id, for example ?filter[site_id]=111",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter[title_cont]",
      "in": "query",
      "required": false,
      "description": "Filter by title contains, for example ?filter[title_cont]=course",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter[description_cont]",
      "in": "query",
      "required": false,
      "description": "Filter by description contains, for example ?filter[description_cont]=course",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success, list of offers which the current user may access",
      "content_type": "application/json"
    }
  }
}