Underdog Protocol
  • API Documentation
  • Quickstart
  • Guides
    • Postman
    • Endpoints
    • Authentication
    • Pagination
    • Errors
    • Webhooks
    • Architecture
  • Resources
    • Projects
      • Transferable Projects
      • Non-Transferable Projects
      • NFTs
        • List all NFTs
        • Search NFTs
        • Create an NFT
        • Retrieve an NFT
        • Update an NFT
        • Generate Claim Link
        • Revoke an NFT
        • Burn an NFT
      • Methods
        • List all Projects
        • Create a Project
        • Retrieve a Project
        • Update a Project
        • Retrieve Project Stats
    • NFTs
      • Retrieve an NFT
      • Generate Claim Transaction
    • Orgs
      • List all Orgs
    • Transactions
      • List all Transactions
      • Retrieve a Transaction
    • Webhooks
      • List all Webhooks
      • Create a Webhook
      • Delete a Webhook
    • V1
      • Collections
        • List all Collections
        • Create a Collection
        • Retrieve a Collection
      • NFTs
        • List all NFTs
        • Create an NFT
        • Retrieve an NFT
        • Update an NFT
      • Managed NFTs
        • Claim
        • Revoke
  • Examples
    • Zapier Integrations
      • Zapier + Viral Loops
      • Zapier + Github + OpenAI
      • Zapier + Github
      • Zapier + Mailchimp
      • Zapier + Shopify
      • Zapier + Calendly
      • Zapier + Hubspot
      • Zapier + Typeform
    • Underdog with Airtable
      • Create a Project
      • Create NFT on Form Submission
      • Send a Claim Link
      • Updating NFTs
    • Web3 Blog
    • Mint NFTs on iPhone
  • Use Cases
    • Solana Mobile
    • Parcl
Powered by GitBook
On this page
  1. Resources
  2. Projects
  3. Methods

List all Projects

PreviousMethodsNextCreate a Project

Last updated 2 years ago

Example

curl --location --request GET 'https://dev.underdogprotocol.com/v2/projects?limit=2' \
--header 'Authorization: Bearer {token}'
const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://dev.underdogprotocol.com/v2/projects?limit=2',
  headers: { 
    'Authorization': 'Bearer {token}'
  }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
Response
{
    "results": [
        {
            "id": 1,
            "transferable": false,
            "mintAddress": "D7MRhsnN5MSSsYVwY1NiAomW1ZrFBGnsEfMnrKULAFva",
            "ownerAddress": "J7oqTbAUdMazGbBs4LZRpKv6SNE4k1GVqkxTQz526vkz",
            "name": "Project #1",
            "description": "",
            "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/D7MRhsnN5MSSsYVwY1NiAomW1ZrFBGnsEfMnrKULAFva/image.png"
        },
        {
            "id": 2,
            "transferable": false,
            "mintAddress": "FX2cGp5jUvfHfoAFE9PnPFnS5DC9AyLugaTNgbVq4Dd5",
            "ownerAddress": "3Wku1E83DskbBaxwPBwD1BXNzX1B1VVEqp75P2oLxWTk",
            "name": "Project #3",
            "description": "",
            "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/FX2cGp5jUvfHfoAFE9PnPFnS5DC9AyLugaTNgbVq4Dd5/image.png"
        }
    ],
    "page": 1,
    "limit": 2,
    "totalPages": 3,
    "totalResults": 5
}

List all Projects

get

This endpoint allows you to retrieve a paginated list of all your Projects. By default, a maximum of ten Projects are shown per page.

Authorizations
Query parameters
pagenumber | nullableOptional
limitnumber | nullableOptional
Responses
200
Returns a paginated list of Projects
application/json
401
Unauthorized
application/json
get
GET /v2/projects HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer JWT
Accept: */*
{
  "results": [
    {
      "name": "NFT #1",
      "symbol": "NFT",
      "description": "This is my first NFT",
      "image": "https://example.com/image.png",
      "animationUrl": "https://example.com/animation.mp4",
      "id": 1,
      "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
      "transferable": true,
      "status": "text"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalPages": 1,
  "totalResults": 1
}
  • GETList all Projects
  • Example