Skip to main content
API docs by Redocly

Phosphor Admin API (v1)

Download OpenAPI specification:Download

Terms of Service

@generated by Phosphor.

Authentication

Get all API keys for the current user

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new API key

Authorizations:
API_KEYNone
Request Body schema: application/json
name
required
string

SafeString

permissions
Array of strings or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "permissions": null
}

Response samples

Content type
application/json
{
  • "expiration": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": null,
  • "last_used": null,
  • "name": "string",
  • "permissions": [
    ]
}

Delete an API key

Authorizations:
API_KEYNone
path Parameters
api_key_id
required
string <uuid>

Responses

Get API key by id

Authorizations:
API_KEYNone
path Parameters
api_key_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "expiration": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_used": null,
  • "name": "string",
  • "permissions": [
    ]
}

Get the current user

Authorizations:
API_KEYNone

Responses

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "permissions": [
    ],
  • "user": {
    }
}

Collection

Get all collections

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

name
string
Default: null

SafeString

contract_address
string
Default: null

ChecksumAddress

token_type
string
Default: null
Enum: "ERC721" "ERC1155" null
network_id
integer <int32>
Default: null
order_by
string
Default: "NAME"
Enum: "NAME" null
testnet
boolean
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new collection

Authorizations:
API_KEYNone
Request Body schema: application/json
default_item_type_id
string or null <uuid>
Default: null
object or null
Default: null
description
string or null
Default: null

SafeString

editable_metadata
boolean
Default: false
external_link
string or null
Default: null

SafeString

image_url
string or null
Default: null

SafeString

is_public
boolean
Default: true
object or null
Default: null
name
required
string

SafeString

object or null
Default: null
reveal_strategy
string or null
Default: null
Enum: "INSTANT" "DELAYED" null

Responses

Request samples

Content type
application/json
{
  • "default_item_type_id": null,
  • "deployment_request": null,
  • "description": null,
  • "editable_metadata": false,
  • "external_link": null,
  • "image_url": null,
  • "is_public": true,
  • "media": null,
  • "name": "string",
  • "preview_metadata": null,
  • "reveal_strategy": "INSTANT"
}

Response samples

Content type
application/json
{
  • "base_uri": null,
  • "default_item_type_id": null,
  • "deployment": null,
  • "description": null,
  • "editable_metadata": true,
  • "external_link": null,
  • "functions_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image_url": null,
  • "is_public": true,
  • "media": null,
  • "name": "string",
  • "preview_metadata": null,
  • "reveal_hidden": true,
  • "reveal_strategy": "INSTANT",
  • "royalty_info": null
}

Delete a collection

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>

Responses

Get a collection by id

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "base_uri": null,
  • "default_item_type_id": null,
  • "deployment": null,
  • "description": null,
  • "editable_metadata": true,
  • "external_link": null,
  • "functions_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image_url": null,
  • "is_public": true,
  • "media": null,
  • "name": "string",
  • "preview_metadata": null,
  • "reveal_hidden": true,
  • "reveal_strategy": "INSTANT",
  • "royalty_info": null
}

Edit a collection

This is a partial update, only attributes present will be updated.

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
Request Body schema: application/json
default_item_type_id
string or null <uuid>
Default: null
description
string or null
Default: null

SafeString

editable_metadata
boolean or null
Default: null
external_link
string or null
Default: null

SafeString

functions_enabled
boolean
Default: false
image_url
string or null
Default: null

SafeString

is_public
boolean or null
Default: null
object or null
Default: null
name
string or null
Default: null

SafeString

object or null
Default: null
reveal_hidden
boolean or null
Default: null
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "default_item_type_id": null,
  • "description": null,
  • "editable_metadata": null,
  • "external_link": null,
  • "functions_enabled": false,
  • "image_url": null,
  • "is_public": null,
  • "media": null,
  • "name": null,
  • "preview_metadata": null,
  • "reveal_hidden": null,
  • "royalty_info": null
}

Response samples

Content type
application/json
{
  • "base_uri": null,
  • "default_item_type_id": null,
  • "deployment": null,
  • "description": null,
  • "editable_metadata": true,
  • "external_link": null,
  • "functions_enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image_url": null,
  • "is_public": true,
  • "media": null,
  • "name": "string",
  • "preview_metadata": null,
  • "reveal_hidden": true,
  • "reveal_strategy": "INSTANT",
  • "royalty_info": null
}

Gets contract details by collection id

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "PENDING",
  • "transaction_id": null
}

Submit a request to deploy a contract for the collection.

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
Request Body schema: application/json
object or null
Default: null
object or null
Default: null
network_id
required
integer or string <Uint256>
object or null
Default: null
token_id_assignment_strategy
string or null
Default: null
Enum: "AUTOMATIC" "MANUAL" "EXTERNAL" null
type
required
string
Enum: "PLATFORM" "CUSTOM" "EXTERNAL"

Responses

Request samples

Content type
application/json
{
  • "custom": null,
  • "external": null,
  • "network_id": null,
  • "platform": null,
  • "token_id_assignment_strategy": "AUTOMATIC",
  • "type": "PLATFORM"
}

Response samples

Content type
application/json
{
  • "status": "PENDING",
  • "transaction_id": null
}

Get contract functions defined on a collection contract

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get a contract function by collection and function id

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
function_id
required
string

Responses

Response samples

Content type
application/json
{
  • "abi": {
    },
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Enable a collection contract function to be callable

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
function_id
required
string
Request Body schema: application/json
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "contract_func": {
    }
}

Read from a contract function by collection and function id

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
function_id
required
string
Request Body schema: application/json
required
Array of (object or null) or (Array of any or null) or (number or null) or (string or null) or (boolean or null)
Array
One of
object or null

Responses

Request samples

Content type
application/json
{
  • "arguments": [
    ]
}

Response samples

Content type
application/json
{
  • "result": { }
}

Execute a contract function by collection and function id

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>
function_id
required
string
Request Body schema: application/json
required
Array of (object or null) or (Array of any or null) or (number or null) or (string or null) or (boolean or null)
Array
One of
object or null

Responses

Request samples

Content type
application/json
{
  • "arguments": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482"
}

Request a metadata refresh for the given collection

This makes no guarantees on if/when the request will be made. This is only applicable to items linked to external contracts.

Authorizations:
API_KEYNone
path Parameters
collection_id
required
string <uuid>

Responses

Contract

Verify capabilities for a token contract

The contract must have one of the following capabilities:

  • ERC721
  • ERC1155

Otherwise, the contract will be rejected.

In order to be able to mint items through the platform, the contract should have one of the following capabilities:

  • ADMIN_MINT_SINGLE (for ERC721)
  • MINT_VOUCHER (for ERC721)
  • ADMIN_MINT_SINGLE_URI (for ERC721)
  • ADMIN_MINT_MULTIPLE_NO_ID (for ERC721)
  • ADMIN_MINT_MULTIPLE (for ERC1155)

Capabilities are determined by the contract's ABI. You can get the known capabilities ABIs from the public capabilities endpoint.

Authorizations:
API_KEYNone
Request Body schema: application/json
required
Array of (object or null) or (Array of any or null) or (number or null) or (string or null) or (boolean or null)
bytecode
required
string

HexString

required
Array of (object or null) or (Array of any or null) or (number or null) or (string or null) or (boolean or null)
token_type
string or null
Default: null
Enum: "ERC721" "ERC1155" null

Responses

Request samples

Content type
application/json
{
  • "abi": [
    ],
  • "bytecode": "string",
  • "constructor_args": [
    ],
  • "token_type": "ERC721"
}

Response samples

Content type
application/json
{
  • "capabilities": [
    ]
}

Email Claim

Get all email claims

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

collection_ids
Array of strings <uuid> [ items <uuid > ]
Default: null
item_ids
Array of strings <uuid> [ items <uuid > ]
Default: null
token_ids
Array of strings
Default: null
email
string
Default: null

Email

claimed
boolean
Default: null
active
boolean
Default: null
transaction_id
Array of strings <uuid> [ items <uuid > ]
Default: null
order_by
string
Default: null
Enum: "CREATED_AT" "EXPIRATION" "CLAIMED_AT" null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new email claim

Authorizations:
API_KEYNone
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
email
required
string

Email

item_id
required
string <uuid>
quantity
required
integer or string <Uint256>
tx_payer
string
Default: "SELLER"
Enum: "BUYER" "SELLER" null
type
string or null
Default: null
Enum: "MINT" "TRANSFER" null

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "email": "string",
  • "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
  • "quantity": null,
  • "tx_payer": "BUYER",
  • "type": "MINT"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "campaign_id": null,
  • "claimed": true,
  • "claimed_at": null,
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
  • "last_pin_code_email_sent_at": null,
  • "quantity": 0,
  • "to_address": null,
  • "token_id": "string",
  • "transaction_id": null,
  • "tx_hash": null,
  • "tx_payer": "BUYER",
  • "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}

Revokes an email claim with the given id

Authorizations:
API_KEYNone
path Parameters
claim_id
required
string <uuid>

Responses

Get email claim by id

Authorizations:
API_KEYNone
path Parameters
claim_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "campaign_id": null,
  • "claimed": true,
  • "claimed_at": null,
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
  • "last_pin_code_email_sent_at": null,
  • "quantity": 0,
  • "to_address": null,
  • "token_id": "string",
  • "transaction_id": null,
  • "tx_hash": null,
  • "tx_payer": "BUYER",
  • "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}

Resends an email claim with the given id.

Authorizations:
API_KEYNone
path Parameters
claim_id
required
string <uuid>
Request Body schema: application/json
email
string or null
Default: null

Email

Responses

Request samples

Content type
application/json
{
  • "email": null
}

Response samples

Content type
application/json
{
  • "active": true,
  • "campaign_id": null,
  • "claimed": true,
  • "claimed_at": null,
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
  • "last_pin_code_email_sent_at": null,
  • "quantity": 0,
  • "to_address": null,
  • "token_id": "string",
  • "transaction_id": null,
  • "tx_hash": null,
  • "tx_payer": "BUYER",
  • "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}

Email Integration

Get all email integration configs for an organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

provider
string
Default: null

SafeString

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new organization email config

Authorizations:
API_KEYNone
Request Body schema: application/json
required
object
provider
required
string
Enum: "MAILGUN" "AMAZON_SES" "SENDGRID" "CUSTOM_SMTP"

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "provider": "MAILGUN"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "MAILGUN"
}

Creates and sends a new test mail

Authorizations:
API_KEYNone
Request Body schema: application/json
to
required
string

Email

Responses

Request samples

Content type
application/json
{
  • "to": "string"
}

Delete an organization email config

Authorizations:
API_KEYNone
path Parameters
integration_id
required
string <uuid>

Responses

Get organization email config by id

Authorizations:
API_KEYNone
path Parameters
integration_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "MAILGUN"
}

Edit an organization email config

Authorizations:
API_KEYNone
path Parameters
integration_id
required
string <uuid>
Request Body schema: application/json
required
object
provider
required
string
Enum: "MAILGUN" "AMAZON_SES" "SENDGRID" "CUSTOM_SMTP"

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "provider": "MAILGUN"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "MAILGUN"
}

Email Template

Get all the customized email templates for the organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

campaign_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get all the customizable email template types

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Delete a customized email template of the given type

If a campaign id is provided, it searches and deletes the email template for the campaign. If no campaign id provided, it searches and deletes the email template for the DEFAULT campaign. If no customized email template of this type can be found, it raises an exception.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null
}

Get a customizable email template of the given type for the organization

If a campaign id is provided, it returns the customized email template of this type from the campaign. If no campaign id provided, it returns the customized email template of this type from the DEFAULT campaign. If no customized templates are found, it returns the platform default for this type.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"
query Parameters
campaign_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "email_from": null,
  • "html": "string",
  • "origin_type": "PLATFORM_DEFAULT",
  • "subject": "string",
  • "template_type": "USER_INVITE"
}

Update a customized email template of the given type

If a campaign id is provided, it searches and updates the email template for the campaign. If no campaign id provided, it searches and updates the email template for the DEFAULT campaign. If no customized email template of this type can be found, it raises an exception.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
email_from
string or null
Default: null

SafeString

html
required
string

SafeString

subject
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "email_from": null,
  • "html": "string",
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "email_from": null,
  • "html": "string",
  • "origin_type": "PLATFORM_DEFAULT",
  • "subject": "string",
  • "template_type": "USER_INVITE"
}

Create a new email template of the given type

If a campaign id is provided, it creates a new email template of this type for the campaign. If no campaign id provided, it creates a new email template of this type for the DEFAULT campaign.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
email_from
string or null
Default: null

SafeString

html
required
string

SafeString

subject
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "email_from": null,
  • "html": "string",
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "email_from": null,
  • "html": "string",
  • "origin_type": "PLATFORM_DEFAULT",
  • "subject": "string",
  • "template_type": "USER_INVITE"
}

Send a test mail of a given template type

If a campaign id is provided, it sends a test email of this template type from the campaign. If no campaign id provided, it sends a test email of this template type from the DEFAULT campaign. If no customized templates are found, it uses the platform default for this type.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
html
required
string

SafeString

subject
required
string

SafeString

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "html": "string",
  • "subject": "string",
  • "variables": [
    ]
}

Get all the variables for a specific template

Variables are derived from the platform default. Variables used in the templates should be wrapped in double curly brackets.

Authorizations:
API_KEYNone
path Parameters
template_type
required
string
Enum: "USER_INVITE" "WELCOME" "INSUFFICIENT_BALANCE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" "CUSTOM"

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Item Type

Gets all item types for the organization of a specific organization ID (if supplied), or the calling user.

Only organization or platform admins have access to this data. If no organization ID is supplied, platform admins will get all item types. If no organization ID is supplied, an org admin will get the item types of his organization.

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

organization_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new item type for an organization.

If not supplied, the organization of the requesting user is used.

Authorizations:
API_KEYNone
Request Body schema: application/json
required
object
name
required
string

SafeString

organization_id
string or null <uuid>
Default: null

Responses

Request samples

Content type
application/json
{
  • "json_schema": {
    },
  • "name": "string",
  • "organization_id": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "json_schema": {
    },
  • "name": "string",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get the meta schema (+example) which is used to validate an item type schema.

Only organization or platform admins have access to this data.

Authorizations:
API_KEYNone

Responses

Response samples

Content type
application/json
{
  • "example_json_schema": {
    },
  • "meta_json_schema": {
    }
}

Delete a specific item type.

Only following item types can be deleted:

  • Specific to your organization.
  • Not associated with an item and/or collection.
Authorizations:
API_KEYNone
path Parameters
item_type_id
required
string <uuid>

Responses

Get a specific item type for an organization.

Authorizations:
API_KEYNone
path Parameters
item_type_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "json_schema": {
    },
  • "name": "string",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Edits an existing item type for an organization.

Authorizations:
API_KEYNone
path Parameters
item_type_id
required
string <uuid>
Request Body schema: application/json
required
object
name
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "json_schema": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "json_schema": {
    },
  • "name": "string",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Item

Get all items associated with this collection

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

collection_id
required
string <uuid>
token_id
Array of strings
Default: null
attributes
Array of strings
Default: null
locked
boolean
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new item associated with the given collection

Authorizations:
API_KEYNone
Request Body schema: application/json
required
object
collection_id
required
string <uuid>
item_type_id
string or null <uuid>
Default: null

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "item_type_id": null
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_type_id": null,
  • "locked": true,
  • "max_supply": null,
  • "media": {
    },
  • "royalty_info": null,
  • "token_id": null,
  • "token_status": "MINTED"
}

Edit item metadata associated with an existing item

Authorizations:
API_KEYNone
Request Body schema: application/json
required
Array of objects
Array
object or null
Default: null
item_id
required
string <uuid>
item_type_id
string or null <uuid>
Default: null
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a bulk set of items associated with the given collection

Authorizations:
API_KEYNone
Request Body schema: application/json
required
Array of objects
Array
required
object
collection_id
required
string <uuid>
(object or null) or (Array of any or null) or (number or null) or (string or null) or (boolean or null)
Default: null

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "item_ids": [
    ]
}

Request the lock of one or more items.

There are three ways to specify the items to lock. When specifying individual items, they should all be unlocked, else the request will fail.

  1. item_id - Locks a single item
  2. item_ids - Locks a list of items by their ids.
  3. collection_id - Locks all remaining unlocked items in a collection.

For the max_supply parameter:

  • (for ERC721's) it should always be 1. If not specified, then it will be coerced to 1.
  • (for ERC1155's) it should be greater than 0. If not specified, then it will be coerced to the max value of a web3 uint128.

For the token_id parameter:

  • This can only be done for a single item and if the token assignment strategy of the collection is set to MANUAL.
  • If left out, the token assignment strategy of the collection should be set to either AUTOMATIC or EXTERNAL.

Once an item has been locked the following actions will be available:

  • Listing
  • Minting
  • Transferring
  • Sending via an email claim
Authorizations:
API_KEYNone
Request Body schema: application/json
collection_id
string or null <uuid>
Default: null
item_id
string or null <uuid>
Default: null
item_ids
Array of strings or null <uuid>
Default: null
max_supply
string or null
Default: null

Uint256

token_id
string or null
Default: null

Uint256

Responses

Request samples

Content type
application/json
{
  • "collection_id": null,
  • "item_id": null,
  • "item_ids": null,
  • "max_supply": null,
  • "token_id": null
}

Response samples

Content type
application/json
{
  • "lock_outputs": [
    ]
}

Delete item by id

Authorizations:
API_KEYNone
path Parameters
item_id
required
string <uuid>

Responses

Get an item by id

Authorizations:
API_KEYNone
path Parameters
item_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_type_id": null,
  • "locked": true,
  • "max_supply": null,
  • "media": {
    },
  • "royalty_info": null,
  • "token_id": null,
  • "token_status": "MINTED"
}

Update an item

This is a full update -- all attributes specified will overwrite ALL existing attributes and item-type specific attributes must be valid against the item type schema. (if any) Attributes cannot be updated once an item has been minted, unless the collection has editable_metadata=True.

Authorizations:
API_KEYNone
path Parameters
item_id
required
string <uuid>
Request Body schema: application/json
object or null
Default: null
item_type_id
string or null <uuid>
Default: null
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "attributes": null,
  • "item_type_id": null,
  • "royalty_info": null
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_type_id": null,
  • "locked": true,
  • "max_supply": null,
  • "media": {
    },
  • "royalty_info": null,
  • "token_id": null,
  • "token_status": "MINTED"
}

Request a metadata refresh

This makes no guarantees on if/when the request will be made. This is only applicable to items linked to external contracts.

Authorizations:
API_KEYNone
path Parameters
item_id
required
string <uuid>

Responses

Get an item's status by id

Authorizations:
API_KEYNone
path Parameters
item_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "email_claim_ids": [
    ],
  • "listing_ids": [
    ],
  • "mint_request_ids": [
    ],
  • "reservations": {
    },
  • "supply": {
    },
  • "transfer_request_ids": [
    ]
}

Get paginated item mint request details.

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

item_id
string <uuid>
Default: null
collection_id
string <uuid>
Default: null
to_address
string
Default: null

ChecksumAddress

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Request the mint of one or more items.

This submits a request to mint one or more items and returns the transaction details on the newly created requests. There are five ways to specify the items to mint:

  1. item_id - Mint a single item
  2. item_ids - Mint a list of items by their ids.
  3. collection_id - Mint all locked and un-minted items in a collection. Reserved items (email claims, listings) will not be considered when minting.
  4. collection_id & token_ids - Mint a list of items by their token ids.
  5. collection_id & token_ranges - Mint a list of items by token ranges.

All items must be locked and not currently minted, else the request will fail.

When minting, a to_address must be specified. This is the address that will receive the newly minted items.

There is currently a limit of 100 items that can be minted at once. When passing a set of individual item identifiers, the request will fail if you attempt to submit more than 100 items. When passing collection_id, only the first 100 will be considered. If you need to mint more than 100 items, you will need to make multiple requests.

Authorizations:
API_KEYNone
Request Body schema: application/json
collection_id
string or null <uuid>
Default: null
item_id
string or null <uuid>
Default: null
item_ids
Array of strings or null <uuid>
Default: null
quantities
Array of strings or null
Default: null
quantity
string or null
Default: null

Uint256

to_address
string or null
Default: null

ChecksumAddress

to_addresses
Array of strings or null
Default: null
token_ids
Array of strings or null
Default: null
Array of objects or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "collection_id": null,
  • "item_id": null,
  • "item_ids": null,
  • "quantities": null,
  • "quantity": null,
  • "to_address": null,
  • "to_addresses": null,
  • "token_ids": null,
  • "token_ranges": null
}

Response samples

Content type
application/json
{
  • "mint_requests": [
    ]
}

Get the item mint request details.

Authorizations:
API_KEYNone
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
  • "quantity": "string",
  • "state": "PENDING",
  • "to_address": "string",
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "tx_hash": null
}

Listing

Get Listings

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

item_id
string <uuid>
Default: null
collection_id
string <uuid>
Default: null
status
string
Default: null
Enum: "ACTIVE" "CANCELLED" "COMPLETE" "PENDING_TX" null
campaign_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new listing

Authorizations:
API_KEYNone
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
collection_id
string or null <uuid>
Default: null
currency
required
string
Enum: "USD" "ETH" "ERC20" "EUR"
end_time
string or null <date-time>
Default: null

UtcDateTime

item_id
string or null <uuid>
Default: null
item_ids
Array of strings or null <uuid>
Default: null
max_quantity_per_tx
required
integer <int32>
payment_providers
required
Array of strings
Items Enum: "STRIPE" "MINT_VOUCHER" "EMAIL_CLAIM" "ORGANIZATION" "BETA_FREE_MINT"
required
object
price
required
string

Uint256

quantity_listed
integer or string or null <Uint256>
Default: null
object or null
Default: null
start_time
string or null <date-time>
Default: null

UtcDateTime

token_ids
Array of strings or null
Default: null
Array of objects or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "collection_id": null,
  • "currency": "USD",
  • "end_time": null,
  • "item_id": null,
  • "item_ids": null,
  • "max_quantity_per_tx": 0,
  • "payment_providers": [
    ],
  • "policy": {
    },
  • "price": "string",
  • "quantity_listed": null,
  • "settlement_currency": null,
  • "start_time": null,
  • "token_ids": null,
  • "token_ranges": null
}

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "collection_id": null,
  • "currency": "USD",
  • "end_time": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "max_quantity_per_tx": 0,
  • "payment_providers": [
    ],
  • "policy": null,
  • "price": "string",
  • "quantity_listed": 0,
  • "quantity_remaining": 0,
  • "sale_type": "SET_PRICE",
  • "settlement_currency": null,
  • "start_time": null,
  • "status": "ACTIVE"
}

Delete Listing

Authorizations:
API_KEYNone
path Parameters
listing_id
required
string <uuid>

Responses

Get Listing by id

Authorizations:
API_KEYNone
path Parameters
listing_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "collection_id": null,
  • "currency": "USD",
  • "end_time": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "max_quantity_per_tx": 0,
  • "payment_providers": [
    ],
  • "policy": null,
  • "price": "string",
  • "quantity_listed": 0,
  • "quantity_remaining": 0,
  • "sale_type": "SET_PRICE",
  • "settlement_currency": null,
  • "start_time": null,
  • "status": "ACTIVE"
}

Edit Listing

Authorizations:
API_KEYNone
path Parameters
listing_id
required
string <uuid>
Request Body schema: application/json
campaign_id
string or null <uuid>
Default: null
end_time
string or null <date-time>
Default: null

UtcDateTime

object or null
Default: null
start_time
string or null <date-time>
Default: null

UtcDateTime

Responses

Request samples

Content type
application/json
{
  • "campaign_id": null,
  • "end_time": null,
  • "policy": null,
  • "start_time": null
}

Response samples

Content type
application/json
{
  • "campaign_id": null,
  • "collection_id": null,
  • "currency": "USD",
  • "end_time": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "max_quantity_per_tx": 0,
  • "payment_providers": [
    ],
  • "policy": null,
  • "price": "string",
  • "quantity_listed": 0,
  • "quantity_remaining": 0,
  • "sale_type": "SET_PRICE",
  • "settlement_currency": null,
  • "start_time": null,
  • "status": "ACTIVE"
}

Get all purchase intents for an organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

item_id
string <uuid>
Default: null
collection_id
string <uuid>
Default: null
listing_id
string <uuid>
Default: null
status
Array of strings
Default: null
Items Enum: "PENDING" "UNRESOLVED" "CANCELLED" "CONFIRMED" "EXPIRED"
email
string
Default: null

Email

eth_address
string
Default: null

ChecksumAddress

fulfillment_status
Array of strings
Default: null
Items Enum: "PENDING" "ASSIGNED" "COMPLETED" "EXCEPTION"
fulfillment_method
Array of strings
Default: null
Items Enum: "EMAIL" "TRANSFER" "VOUCHER"
payment_provider
Array of strings
Default: null
Items Enum: "STRIPE" "MINT_VOUCHER" "EMAIL_CLAIM" "ORGANIZATION" "BETA_FREE_MINT"

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get purchase intent by id

Authorizations:
API_KEYNone
path Parameters
purchase_intent_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": null,
  • "eth_address": null,
  • "expiration": "2019-08-24T14:15:22Z",
  • "fulfillment_method": "EMAIL",
  • "fulfillment_status": "PENDING",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_claim_ids": null,
  • "listing_id": "5322d4a9-51d2-4408-82fb-01ffecfb8304",
  • "payment_provider": "STRIPE",
  • "provider_price": {
    },
  • "status": "PENDING",
  • "stripe_payment_intent_id": null,
  • "transaction_ids": null
}

Get purchase intent by id. Only returns items that have been assigned to the purchase intent and that have an associated token id.

Authorizations:
API_KEYNone
path Parameters
purchase_intent_id
required
string <uuid>
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Marketing Campaign

Get all marketing campaigns

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

name
string
Default: null

SafeString

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a new marketing campaign

Authorizations:
API_KEYNone
Request Body schema: application/json
email_from
string or null
Default: null

SafeString

name
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "email_from": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "email_from": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete marketing campaign with the id

Authorizations:
API_KEYNone
path Parameters
campaign_id
required
string <uuid>

Responses

Get marketing campaign by id

Authorizations:
API_KEYNone
path Parameters
campaign_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "email_from": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Edit marketing campaign with the id

Authorizations:
API_KEYNone
path Parameters
campaign_id
required
string <uuid>
Request Body schema: application/json
email_from
string or null
Default: null

SafeString

name
string or null
Default: null

SafeString

Responses

Request samples

Content type
application/json
{
  • "email_from": null,
  • "name": null
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "email_from": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Network

Get the available networks

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get a specific network

Authorizations:
API_KEYNone
path Parameters
network_id
required
integer or string <Uint256>

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "gas_policy_id": null,
  • "id": 0,
  • "name": "string",
  • "payment_tokens": null,
  • "testnet": true
}

Payment Tokens

Returns all tokens of specified network id

Authorizations:
API_KEYNone
path Parameters
network_id
required
integer or string <Uint256>
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create payment token for specified network

Authorizations:
API_KEYNone
path Parameters
network_id
required
integer or string <Uint256>
Request Body schema: application/json
address
required
string

ChecksumAddress

eth
boolean
Default: false
eur_stablecoin
boolean
Default: false
usd_stablecoin
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "eth": false,
  • "eur_stablecoin": false,
  • "usd_stablecoin": false
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "decimals": 0,
  • "eth": false,
  • "eur_stablecoin": false,
  • "network_id": 0,
  • "symbol": "string",
  • "usd_stablecoin": false
}

Delete payment token from specified network

Authorizations:
API_KEYNone
path Parameters
network_id
required
integer or string <Uint256>
address
required
string

Responses

Organization

Get the organization payout configuration.

The user must have access to the desired organization.

Authorizations:
API_KEYNone
path Parameters
organization_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "payout_address": "string",
  • "platform_sale_fee": 0
}

Edit an organization payout configuration

Authorizations:
API_KEYNone
path Parameters
organization_id
required
string <uuid>
Request Body schema: application/json
payout_address
string or null
Default: null

ChecksumAddress

platform_sale_fee
number or null [ 0 .. 10000 ]
Default: null

BasisPoints

Responses

Request samples

Content type
application/json
{
  • "payout_address": null,
  • "platform_sale_fee": null
}

Response samples

Content type
application/json
{
  • "payout_address": "string",
  • "platform_sale_fee": 0
}

Role

Get roles available for the current organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

name
string
Default: null

SafeString

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Snapshot

Get Snapshots

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create new Snapshot

Authorizations:
API_KEYNone
Request Body schema: application/json
collection_id
string or null <uuid>
Default: null
contract_address
string or null
Default: null

SafeString

required
object
name
required
string

SafeString

network_id
integer or string or null <Uint256>
Default: null
token_type
string or null
Default: null
Enum: "ERC721" "ERC1155" null

Responses

Request samples

Content type
application/json
{
  • "collection_id": null,
  • "contract_address": null,
  • "criteria": {
    },
  • "name": "string",
  • "network_id": null,
  • "token_type": "ERC721"
}

Response samples

Content type
application/json
{
  • "collection_id": null,
  • "contract_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "criteria": {
    },
  • "holder_count": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "network_id": 0,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "status": "PENDING",
  • "token_type": "ERC721"
}

Delete snapshot

Authorizations:
API_KEYNone
path Parameters
snapshot_id
required
string <uuid>

Responses

Get Snapshot by id

Authorizations:
API_KEYNone
path Parameters
snapshot_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "collection_id": null,
  • "contract_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "criteria": {
    },
  • "holder_count": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "network_id": 0,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "status": "PENDING",
  • "token_type": "ERC721"
}

Edit Snapshot by id

Authorizations:
API_KEYNone
path Parameters
snapshot_id
required
string <uuid>
Request Body schema: application/json
name
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "collection_id": null,
  • "contract_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "criteria": {
    },
  • "holder_count": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "network_id": 0,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "status": "PENDING",
  • "token_type": "ERC721"
}

Get Snapshot holders

Authorizations:
API_KEYNone
path Parameters
snapshot_id
required
string <uuid>
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
integer <int32> [ 1 .. 10000 ]
Default: 100

LargePaginationLimit

output_type
string
Default: "PER_ADDRESS"
Enum: "PER_ADDRESS" "PER_TOKEN"
holder
Array of strings
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": null,
  • "total_results": 0
}

Get Snapshot holders csv

Authorizations:
API_KEYNone
path Parameters
snapshot_id
required
string <uuid>
query Parameters
output_type
string
Default: "PER_TOKEN"
Enum: "PER_ADDRESS" "PER_TOKEN"

Responses

Transaction

Get all transactions for an organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 1000 ]
Default: 100

MediumPaginationLimit

network_ids
Array of integers <int32> [ items <int32 > ]
Default: null
tx_types
Array of strings
Default: null
Items Enum: "DEPLOY_TOKEN_CONTRACT" "DEPLOY_CONTRACT_VIA_FACTORY" "SET_APPROVAL_FOR_ALL" "MINT_TOKEN" "ADMIN_MINT_WITH_URI" "TRANSFER_TOKEN" "CREATE_FOR_ADMIN_MINT" "FUND_ACCOUNT" "WITHDRAW_BALANCE" "ADMIN_MINT" "ADMIN_MINT_NO_ID" "TRANSFER_OWNERSHIP" "GRANT_ROLE" "GRANT_MANY" "INVOKE_FUNCTION" "SET_CONTRACT_ROYALTY" "SET_PER_TOKEN_ROYALTY" "UNSET_PER_TOKEN_ROYALTY" "DISTRIBUTOR_CONTRACT" "SET_BASE_URI" "TRANSFER_ERC20" "BULK_ADMIN_MINT" "BILLING_STATUS" "CREATE_TOKEN_FIXED_PRICE" "DISPERSE"
states
Array of strings
Default: null
Items Enum: "PENDING" "SUBMITTED" "COMPLETED" "CANCELLED" "QUEUED"
signers
Array of strings
Default: null
item_id
string <uuid>
Default: null
collection_id
string <uuid>
Default: null
order_by
string
Default: "CREATED_AT"
Enum: "CREATED_AT" null
on_chain_status
string
Default: null
Enum: "FAILURE" "SUCCESS" null
has_failures
boolean
Default: null
billing_status
string
Default: null
Enum: "NEW" "INITIATED" "COMPLETED" "CANCELED" "EXPIRED" "FAILED" "NO_CHARGE" null
testnet
boolean
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get a specific transaction

Authorizations:
API_KEYNone
path Parameters
transaction_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "billing_details": null,
  • "billing_status": "NEW",
  • "collection_id": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "effective_gas_price": null,
  • "error_message": null,
  • "failure_count": 0,
  • "gas_used": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "mined_block_number": null,
  • "network_id": 0,
  • "nonce": 0,
  • "on_chain_status": "FAILURE",
  • "on_chain_timestamp": null,
  • "signer": "string",
  • "state": "PENDING",
  • "tx_fee": null,
  • "tx_hash": "string",
  • "tx_type": "DEPLOY_TOKEN_CONTRACT"
}

Edit a specific transaction

Authorizations:
API_KEYNone
path Parameters
transaction_id
required
string <uuid>
Request Body schema: application/json
state
required
string
Enum: "PENDING" "SUBMITTED" "COMPLETED" "CANCELLED" "QUEUED"

Responses

Request samples

Content type
application/json
{
  • "state": "PENDING"
}

Response samples

Content type
application/json
{
  • "billing_details": null,
  • "billing_status": "NEW",
  • "collection_id": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "effective_gas_price": null,
  • "error_message": null,
  • "failure_count": 0,
  • "gas_used": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "mined_block_number": null,
  • "network_id": 0,
  • "nonce": 0,
  • "on_chain_status": "FAILURE",
  • "on_chain_timestamp": null,
  • "signer": "string",
  • "state": "PENDING",
  • "tx_fee": null,
  • "tx_hash": "string",
  • "tx_type": "DEPLOY_TOKEN_CONTRACT"
}

User

Get users for the current organization

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

organization_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Delete user by id

Authorizations:
API_KEYNone
path Parameters
user_id
required
string <uuid>

Responses

Get a user by id

Authorizations:
API_KEYNone
path Parameters
user_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "address": null,
  • "email": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_seen": null,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}

Edit a user

Authorizations:
API_KEYNone
path Parameters
user_id
required
string <uuid>
Request Body schema: application/json
role_id
string or null <uuid>
Default: null

Responses

Request samples

Content type
application/json
{
  • "role_id": null
}

Response samples

Content type
application/json
{
  • "active": true,
  • "address": null,
  • "email": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_seen": null,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}

Webhook

Get all webhooks

Authorizations:
API_KEYNone
query Parameters
order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create webhook

Authorizations:
API_KEYNone
Request Body schema: application/json
enabled
required
boolean
name
required
string

SafeString

secret
required
string

SafeString

url
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string",
  • "secret": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "secret": "string",
  • "url": "string"
}

Send a sample webhook to the given url

Authorizations:
API_KEYNone
Request Body schema: application/json
secret
required
string

SafeString

url
required
string

SafeString

Responses

Request samples

Content type
application/json
{
  • "secret": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "response": null,
  • "success": true
}

Delete webhook

Authorizations:
API_KEYNone
path Parameters
webhook_id
required
string <uuid>

Responses

Edit webhook

Authorizations:
API_KEYNone
path Parameters
webhook_id
required
string <uuid>
Request Body schema: application/json
enabled
boolean or null
Default: null
name
string or null
Default: null

SafeString

secret
string or null
Default: null

SafeString

url
string or null
Default: null

SafeString

Responses

Request samples

Content type
application/json
{
  • "enabled": null,
  • "name": null,
  • "secret": null,
  • "url": null
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "secret": "string",
  • "url": "string"
}