List all Projects

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumber · nullableOptional

limitnumber · max: 100 · nullableOptional

Responses

200

Returns a paginated list of Projects

application/json

pagenumberRequired

Page number

Example: 1

limitnumberRequired

Number per page

Example: 10

totalPagesnumberRequired

Total number of pages

Example: 1

totalResultsnumberRequired

Total number of results

Example: 1

401

Unauthorized

application/json

get/v2/projects

GET /v2/projects HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
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
}

Example

cURL

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

JavaScript

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
}