{ "opencollection": "1.0.0", "info": { "name": "Crossref Agency Works API", "version": "3.32.0" }, "items": [ { "info": { "name": "Works", "type": "folder" }, "items": [ { "info": { "name": "GET /members/{id}/works", "type": "http" }, "http": { "method": "GET", "url": "/members/: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 associated with a Crossref member (deposited by a Crossref member) with {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." }, { "info": { "name": "GET /prefixes/{prefix}/works", "type": "http" }, "http": { "method": "GET", "url": "/prefixes/:prefix/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": "prefix", "value": "", "type": "path" } ] }, "docs": "Returns list of works associated with specified {prefix}.\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 quer" }, { "info": { "name": "GET /funders/{id}/works", "type": "http" }, "http": { "method": "GET", "url": "/funders/: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", "description": "The id of the funder" } ] }, "docs": "Returns list of works associated with the specified {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 quer" }, { "info": { "name": "GET /works/{doi}", "type": "http" }, "http": { "method": "GET", "url": "/works/:doi", "params": [ { "name": "doi", "value": "", "type": "path", "description": "The DOI identifier associated with the work" } ] }, "docs": "Returns metadata for the specified Crossref DOI, as an example use DOI 10.5555/12345678" }, { "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" }, { "info": { "name": "GET /works", "type": "http" }, "http": { "method": "GET", "url": "/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" } ] }, "docs": "Returns a list of all works (journal articles, conference proceedings, books, components, etc), 20 per page.\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/wor" }, { "info": { "name": "GET /works/{doi}/agency", "type": "http" }, "http": { "method": "GET", "url": "/works/:doi/agency", "params": [ { "name": "doi", "value": "", "type": "path", "description": "The DOI identifier associated with the work" } ] }, "docs": "Gets the agency associated with a specific work by its DOI, as an example use DOI 10.5555/12345678" }, { "info": { "name": "GET /journals/{issn}/works", "type": "http" }, "http": { "method": "GET", "url": "/journals/:issn/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": "issn", "value": "", "type": "path", "description": "The ISSN identifier associated with the journal" } ] }, "docs": "Returns a list of works in the journal identified by {issn}.\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 q" } ] } ], "bundled": true }