{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","description":"This REST API would be used to interact with NodiRef's Referral Engine, in order to interact with the routes, you will need to authenticate your requests, see the Authentication section on this documentation so you understand how to use it.\n\nWith this API, you will be able to interact with all the resources from the Referral Management System programatically, the main idea of NodiRef, is that it can act like any other service in your back-end, to manage your partners, referral links and rewards, this way you can offload all the complexity of your reward system to us, and you can handle your main business logic.\n\n### Authentication\n\nIn order to be able to interact with private endpoints of this API, you will need a API Token that you can get from your profile in the Back-Office. Once you get your token, you can use it like a Bearer Token in all your requests, so we can authenticate you. You can use it as follows:\n\n```\nAuthorization: Bearer YOUR_TOKEN_HERE\n\n ```\n\n### Filters\n\nQuery Param: `filter[filter_name]=filter_value`\n\nIn our API, we follow a very simple principle that applies to Filters, Sorts, Pagination and other operation types, which as adding a query parameter with the type of operation, the field that's used and the value, for example:\n\n```\nGET https://api.nodiref.com/partners?filter[external_id]=MyExternalId\n\n ```\n\nAnd internally we will detect it and perform a filter on your request to get the results you are looking for. Typically on every resource you will have a list of filterable fields that you can use.\n\n### Pagination\n\nFor the pagination, you will have different options that you could use, similar to the filters, we use an operation query param, which is page, and we set the options we want, for example:\n\n| Query param | Description |\n| --- | --- |\n| `page` or `page[number]` | Specifies the page to get (Default `1`) |\n| `item_per_page` or `page[size]` | Specifies the items per page (Default `10`) |\n\nNormally you would choose wether you use `page` and `item_per_page` or `page[number]` and `page[size]`, we gave you both possibilities and it's up to you to choose which one you are more comfortable using.\n\n### Includes\n\nIf you want to have extra information on your list, you can include some information that's related to the resource you are querying, for instance, maybe if you are querying the Partners list, you would want to have the Project information whose Partner belong to, you can do this by including the `includes` query parameter into your request, and selecting the available relationship. You can concatenate the includes by separating them with a comma if you need to add more than one. For example:\n\n```\nGET https://api.nodiref.com/partners?include=project\n\n ```\n\nTo have the available fields, you can check in the requests directly, it will be marked there.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38948109","team":8936149,"collectionId":"073dc2c1-fe54-4854-8020-bae53a3edb49","publishedId":"2sB34kEeDp","public":true,"publicUrl":"https://api-docs.nodiref.com","privateUrl":"https://go.postman.co/documentation/38948109-073dc2c1-fe54-4854-8020-bae53a3edb49","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7E5BF6"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Discover the API Documentation of NodiRef to implement a Referral Engine into your applications with ease"},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/ac16d08f-456f-4a4c-ac16-bca46f1cf0ab/bm9kaXJlZi1sb2dvLXdoaXRlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"7E5BF6"}},{"name":"light","logo":"https://content.pstmn.io/3937ac6f-0986-48fc-8a05-8495b44ad292/bm9kaXJlZi1sb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7E5BF6"}}]}},"version":"8.10.1","publishDate":"2025-07-20T13:11:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Discover the API Documentation of NodiRef to implement a Referral Engine into your applications with ease"},"logos":{"logoLight":"https://content.pstmn.io/3937ac6f-0986-48fc-8a05-8495b44ad292/bm9kaXJlZi1sb2dvLnBuZw==","logoDark":"https://content.pstmn.io/ac16d08f-456f-4a4c-ac16-bca46f1cf0ab/bm9kaXJlZi1sb2dvLXdoaXRlLnBuZw=="}},"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/91a3fc65d60cc9dd7a8af358bcdd6a91a0c3b5312344a5a1b6b07056afb6de96","favicon":"https://nodiref.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://api-docs.nodiref.com/view/metadata/2sB34kEeDp"}