{
  "opencollection": "1.0.0",
  "info": {
    "name": "Crossref Agency Types API",
    "version": "3.32.0"
  },
  "items": [
    {
      "info": {
        "name": "Types",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GET /types/{id}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/types/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns information about a metadata work type, as an example use `monograph`"
        },
        {
          "info": {
            "name": "GET /types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/types",
            "params": [
              {
                "name": "rows",
                "value": "",
                "type": "query",
                "description": "The number of rows per page"
              },
              {
                "name": "mailto",
                "value": "",
                "type": "query",
                "description": "The email address to identify yourself and be in the \"polite pool\""
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of rows to skip before returning"
              }
            ]
          },
          "docs": "Returns a list of valid work types.\n## Pagination with offsets\n\nOffsets can be used to iterate over the results. For this route, the maximum number of available results is 80,000, which in this case allows to retrieve all the indexed items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the follo"
        },
        {
          "info": {
            "name": "GET /types/{id}/works",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/types/:id/works",
            "params": [
              {
                "name": "rows",
                "value": "",
                "type": "query",
                "description": "The number of rows per page"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc"
              },
              {
                "name": "facet",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type"
              },
              {
                "name": "sample",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to return `N` randomly sampled items"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to sort results by a certain field, e.g. `score`"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of rows to skip before returning"
              },
              {
                "name": "mailto",
                "value": "",
                "type": "query",
                "description": "The email address to identify yourself and be in the \"polite pool\""
              },
              {
                "name": "select",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to free text query certain fields"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "returns list of works of type {id}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined wi"
        }
      ]
    }
  ],
  "bundled": true
}