Skip to main content

Get collections for an organization

Use the collections endpoint to get [all collections] or a [specific collection] for an organization. Only collections that belong to the organization of the caller are returned.

Get all collections​

Issue a GET request to the collections endpoint to get all collections for your organization.

GET https://admin-api.phosphor.xyz/v1/collections

This is a paginated endpoint that returns results up to a certain limit.

  • Specify a cursor from the previous response to return the next batch of results from the offset.
  • Specify a name, contract_address, token_type, or network_id to filter the results.
  • Specify an order_by of NAME to sort results on the name.
  • Specify an order_direction of ASC or DESC to sort results in an ascending or descending order.
GET https://admin-api.phosphor.xyz/v1/collections?limit=1
Example response (abbreviated)
{
  "cursor": "c3QAQUJDLUZsZXhpYmxlRVJDNzIx",
  "has_more": true,
  "results": [
    {
      "default_item_type_id": null,
      "deployment": {
        "address": "0xa18CfDE4B31dE31a9d9429aa1E6A61CfD990dB04",
        "capabilities": [
          "ERC721",
          "ERC721_METADATA",
          "BURN_TOKEN",
          "OZ_ACCESS_CONTROL",
          "OZ_OWNABLE",
          "SET_BASE_URI",
          "SET_BASE_URI_PERMANENT",
          "MINT_VOUCHER",
          "ERC2981",
          "EIP165",
          "CONTRACT_ROYALTY",
          "PER_TOKEN_ROYALTY",
          "CONTRACT_NAME_SYMBOL",
          "ADMIN_MINT_SINGLE",
          "OS_REGISTRY_FILTER",
          "OS_REGISTRY_FILTER_TOGGLE"
        ],
        "network_id": 59140,
        "symbol": "SSL",
        "token_id_assignment_strategy": "AUTOMATIC",
        "token_type": "ERC721",
        "transaction_id": "33cd2047-ac52-4483-9b4c-04d5da793528"
      },
      "editable_metadata": false,
      "functions_enabled": false,
      "id": "9f55b19c-c166-488a-a242-6253aa27f6e6",
      "image_url": null,
      "name": "ABC-FlexibleERC721",
      "reveal_hidden": false,
      "reveal_strategy": "INSTANT",
      "royalty_info": null
    }
  ],
  "total_results": 4
}
  • cursor indicates an offset from which the next batch of results begins.
  • has_more returns true if there are more results than already displayed.
  • results returns an array of collections from the search.
  • total_results returns the total number of results from the response.

Get a specific collection by ID​

Issue a GET request to the collections endpoint with a collection_id to get details on a specific collection.

GET https://admin-api.phosphor.xyz/v1/collections/{collection_id}
Example response
{
  "default_item_type_id": null,
  "deployment": {
    "address": "0xa18CfDE4B31dE31a9d9429aa1E6A61CfD990dB04",
    "capabilities": [
      "ERC721",
      "ERC721_METADATA",
      "BURN_TOKEN",
      "OZ_ACCESS_CONTROL",
      "OZ_OWNABLE",
      "SET_BASE_URI",
      "SET_BASE_URI_PERMANENT",
      "MINT_VOUCHER",
      "ERC2981",
      "EIP165",
      "CONTRACT_ROYALTY",
      "PER_TOKEN_ROYALTY",
      "CONTRACT_NAME_SYMBOL",
      "ADMIN_MINT_SINGLE",
      "OS_REGISTRY_FILTER",
      "OS_REGISTRY_FILTER_TOGGLE"
    ],
    "network_id": 59140,
    "symbol": "SSL",
    "token_id_assignment_strategy": "AUTOMATIC",
    "token_type": "ERC721",
    "transaction_id": "33cd2047-ac52-4483-9b4c-04d5da793528"
  },
  "editable_metadata": false,
  "functions_enabled": false,
  "id": "9f55b19c-c166-488a-a242-6253aa27f6e6",
  "image_url": null,
  "name": "ABC-FlexibleERC721",
  "reveal_hidden": false,
  "reveal_strategy": "INSTANT",
  "royalty_info": null
}
Last updated on