{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2592cfc9-f585-4adf-b34a-e821f212ecb6","name":"coredna API","description":"## Shared API options\r\n\r\n### Parameters\r\nWhen querying for multiple items (all list APIs) and for some show APIs where the record is not specified through the URL (i.e. giving an ID), it is possible to filter returned records using categories.\r\n\r\nParameters generally must match the property names of the underlying model they are trying to query, where it is also possible to query using related model properties.\r\n\r\nFor example, when you want to retrieve all components that have a certain category id set, you can add `categories.id=999` (where 999 is the category ID) to your request.\r\n\r\nParameter comparison supports additional options that modify how the comparison is performed:\r\n\r\n|Operator|Name|Description|Example|\r\n|---|---|---|---|\r\n|`!`|Negation|Matches records not matching the specified value|`!parent.id=NULL` => Records where the parent id is not null, thus have a parent|\r\n|`>`|GT|Record value needs to be bigger than specified value|`>min=2` => Records where the min property is bigger than two|\r\n|`<`|LT|Record value needs to be smaller than specified value|`<max=4` => Records where the min property is bigger than two|\r\n|`%`|contains|Matches records containing the specified value|`%name=Hello` => Records where the name property contains \"test\"|\r\n|`\\|`|OR|Matches records where any of the specified (comma separated) values matches.|`\\|category.id=2,3` => Any record that has either category 2 or category 3|\r\n|`&`|AND|Matches records where any of the specified (comma separated) values matches.|`&category.id=2,3` => Records that have both category 2 and category 3|\r\n\r\nPlease not operators need to be encoded when they are send in a URL query, so you would need to send for example `%25name=hello`.\r\n\r\n### GraphQL-like response modification\r\nThe API endpoints (CRUD) support specifying properties that should be queried using a GraphQL-like syntax. This way, you can retrieve only the properties you need, but also retrieve related properties from other records without having to do multiple API requests.\r\n\r\nThe API supports standard field definitions and aliases. The following example shows how to query for related properties for a pages property retrieved from the API - this must be sent as string in the `properties` query parameter. Additional white spaces are ignored, so feel free to add line breaks for readability. Field names can be seperated with line breaks (GraphQL standard) or commas (to improve readibility in the query string). Example query:\r\n\r\n```\r\n{\r\n  id\r\n  name\r\n  title: activeRevision.name\r\n  revisions {\r\n    id\r\n    created\r\n    modified\r\n  }\r\n}\r\n```\r\n\r\n### Ordering\r\nWhen querying for multiple elements (i.e. list API requests), you can order the results using the `orderBy` parameter. The parameter accepts a comma-separated list of property-direction tupels (or property paths using dot notation) to order the results by. An example for this would be `orderBy=name:ASC` for sorting elements by their name in ascending order.\r\n\r\n\r\n### Unpublished Records\r\nBy default, unpublished records will not be retrieved when you query for multiple records (using the List endpoints) or when you query for a single record using anything but the record's ID. Records will be retrieved when accessed with an ID (and can thus also be updated or deleted), but this is only possible if the API is used by an authenticated Backend user.\r\n\r\nYou can also specify that you want to retrieve unpublished records (when authenticated as Backend user) using the parameter `retrieveUnpublished=1`.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6917931","team":301392,"collectionId":"2592cfc9-f585-4adf-b34a-e821f212ecb6","publishedId":"Tzm2LeUU","public":true,"publicUrl":"https://api2.coredna.com","privateUrl":"https://go.postman.co/documentation/6917931-2592cfc9-f585-4adf-b34a-e821f212ecb6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ee1e3e"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Core dna API Reference "},{"name":"title","value":"Core dna API reference"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ee1e3e"}}]}},"version":"8.10.0","publishDate":"2025-08-28T06:55:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Core dna API reference","description":"Core dna API Reference "},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ce6618eacba50801177ba29a5e3f6bd13c8f32ae4041e54289484a30649f94a0","favicon":"https://coredna.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api2.coredna.com/view/metadata/Tzm2LeUU"}