/partners | NodiRef - Documentation

This endpoint retrieves the partners list based on the provided filters.

Request

Available filters

external_id (optional): The external ID of the partner.
id (optional): The ID of the partner.
name (optional): The name of the partner.
project_id (optional): The ID of the project associated with the partner.

Available includes

project -> The project to which the Partner belongs
status -> The status of the Partner

GET/partners

Authorization

AuthorizationRequiredBearer <token>

In: header

Response Body

TypeScript Definitions

Use the response body type in TypeScript.

curl -X GET "https://api.nodiref.com/partners" \
  -H "Authorization: Bearer <token>"

{
  "success": true,
  "data": [
    {
      "id": "9ef54e02-2fc1-49f7-8496-b6549b8935c9",
      "name": "Swift, Kemmer and McCullough",
      "external_id": null
    },
    {
      "id": "9ef54e02-35cc-42cd-a4b3-178c08a59581",
      "name": "Renner-Collins",
      "external_id": null
    },
    {
      "id": "9ef54e02-41bc-4ac6-8bca-cf1c0eb7ee5b",
      "name": "Schulist, Friesen and Hickle",
      "external_id": null
    },
    {
      "id": "9ef54e02-47ae-4294-8545-f5916169a2e5",
      "name": "Quitzon Inc",
      "external_id": null
    },
    {
      "id": "9ef54e02-4c91-40c3-ac6b-d4ad4d7af568",
      "name": "Turner-Nienow",
      "external_id": null
    },
    {
      "id": "9ef54e02-6258-4a12-90b2-5be467eb76c0",
      "name": "Kulas, Miller and Cummerata",
      "external_id": null
    },
    {
      "id": "9ef54e02-773f-432f-b1b1-1b36067b551b",
      "name": "Hessel, Barton and Hartmann",
      "external_id": null
    },
    {
      "id": "9ef54e02-7c57-4723-89f4-360734f007fd",
      "name": "Turner Ltd",
      "external_id": null
    },
    {
      "id": "9ef54e02-aab3-44e1-baa1-8ed03f7ac9ee",
      "name": "Kemmer-Sipes",
      "external_id": null
    },
    {
      "id": "9ef54e02-cd8c-467b-81cb-d1587da099e9",
      "name": "Klocko Ltd",
      "external_id": null
    }
  ],
  "pagination": {
    "current_page": 1,
    "first_page_url": "http://localhost:8000/api/partners?page=1",
    "from": 1,
    "last_page": 138,
    "last_page_url": "http://localhost:8000/api/partners?page=138",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http://localhost:8000/api/partners?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=7",
        "label": "7",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=8",
        "label": "8",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=9",
        "label": "9",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=10",
        "label": "10",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=137",
        "label": "137",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=138",
        "label": "138",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/partners?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": "http://localhost:8000/api/partners?page=2",
    "path": "http://localhost:8000/api/partners",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 1378
  }
}