---
agentTools:
  projectIndex: https://copperx.readme.io/llms.txt
---

# Get accounts of a partner by emails

partner_api

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/partners/accounts": {
      "get": {
        "operationId": "PartnerController_getAccount",
        "summary": "Get accounts of a partner by emails",
        "description": "partner_api",
        "parameters": [
          {
            "name": "emails",
            "required": false,
            "in": "query",
            "description": "To filter accounts by email",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/PageDto"
                    },
                    {
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/AccountOnboardResponseDto"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "500": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDto"
                }
              }
            }
          }
        },
        "tags": [
          "Partner"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "Copperx API",
    "description": "Copperx APIs allows you to access to manage payments, transactions and more in a simple way. Our APIs are easy to use and provide an intuitive APIs for developers to create powerful applications.",
    "version": "v0.0.0",
    "contact": {
      "name": "Copperx",
      "url": "https://t.me/+bVxXaalfhF8wMDFl",
      "email": "support@copperx.io"
    }
  },
  "servers": [
    {
      "url": "https://api.copperx.dev",
      "description": "Test"
    },
    {
      "url": "https://api.copperx.io",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "ErrorDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "object"
          },
          "statusCode": {
            "type": "number"
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "statusCode",
          "error"
        ]
      },
      "UserFlagsDto": {
        "type": "object",
        "properties": {
          "introModal": {
            "type": "boolean"
          }
        }
      },
      "UserStatus": {
        "type": "string",
        "enum": [
          "pending",
          "active",
          "suspended"
        ]
      },
      "OrganizationStatus": {
        "type": "string",
        "enum": [
          "pending",
          "active",
          "suspended"
        ]
      },
      "PaymentMethodType": {
        "type": "string",
        "enum": [
          "superfluid",
          "wallet",
          "allowance_based_recurring",
          "stripe",
          "binance_pay"
        ]
      },
      "CryptoCurrency": {
        "type": "string",
        "enum": [
          "usdc",
          "usdt",
          "pyusd",
          "eurc",
          "brett",
          "dai",
          "btc",
          "eth",
          "matic",
          "bnb",
          "sol",
          "busd",
          "trx",
          "food",
          "bonk",
          "wif",
          "goat",
          "spx",
          "truf",
          "pengu"
        ]
      },
      "CheckoutSessionSplitWithdrawalAddressDto": {
        "type": "object",
        "properties": {
          "splitPercentage": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "example": 1
          },
          "address": {
            "type": "string",
            "description": "The withdrawal address for the split percentage"
          }
        },
        "required": [
          "splitPercentage",
          "address"
        ]
      },
      "PaymentSettingChainDto": {
        "type": "object",
        "properties": {
          "chainId": {
            "type": "number",
            "example": 1
          },
          "blacklistCurrencies": {
            "type": "array",
            "description": "The list of currencies to disable for the payment. Note: This field is only used for checkout session API atm.",
            "example": [
              "usdc"
            ],
            "items": {
              "$ref": "#/components/schemas/CryptoCurrency"
            }
          },
          "withdrawalAddress": {
            "type": "string",
            "description": "This is optional, default withdrawal address configured in dashboard under settings > payment methods is used. The custom withdrawal address to use for this chain instead of stored default withdrawal address."
          },
          "withdrawalAddresses": {
            "description": "The list of withdrawal addresses to split the payment. If provided, the sum of all split percentages should be 100.",
            "minItems": 2,
            "maxItems": 4,
            "example": [
              {
                "splitPercentage": 20,
                "address": "0x898bf05dfec6a2cfbfda2877ff759d62beed7fe7"
              },
              {
                "splitPercentage": 80,
                "address": "0xa7d770a5c4276a4d85caba7bea9a1fcbd3672db7"
              }
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckoutSessionSplitWithdrawalAddressDto"
            }
          }
        },
        "required": [
          "chainId"
        ]
      },
      "PaymentSettingDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "paymentMethodTypes": {
            "type": "array",
            "description": "A list of the types of payment methods",
            "example": "wallet",
            "minItems": 1,
            "maxItems": 1,
            "items": {
              "$ref": "#/components/schemas/PaymentMethodType"
            }
          },
          "allowedChains": {
            "description": "The list of chains allowed for the payment. If not provided, all chains supported by the organization are enabled.",
            "example": [
              {
                "chainId": 137
              }
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentSettingChainDto"
            }
          },
          "allowedCurrencies": {
            "type": "array",
            "description": "The list of currencies allowed for the payment.",
            "example": [
              "usdc",
              "usdt"
            ],
            "items": {
              "$ref": "#/components/schemas/CryptoCurrency"
            }
          },
          "preferredChainId": {
            "type": "number",
            "example": 1,
            "description": "The preferred chain's id"
          },
          "preferredCurrency": {
            "description": "The preferred currency for payment",
            "$ref": "#/components/schemas/CryptoCurrency"
          },
          "allowSwap": {
            "type": "boolean",
            "description": "Whether the user can swap the payment currency",
            "default": false
          },
          "applyFee": {
            "type": "boolean",
            "description": "Whether add a application fee to the user payment",
            "default": false
          },
          "feePercentage": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "example": 1,
            "description": "Percent that will be added to subtotal as a fee"
          },
          "applyGasFee": {
            "type": "boolean",
            "description": "Whether add a transaction fee to the user payment",
            "default": false
          },
          "allowSplitPayments": {
            "type": "boolean",
            "description": "Whether the user can split the payment"
          },
          "slippagePercentage": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "example": 1,
            "description": "The slippage percentage allowed for swaps and withdrawals",
            "default": 10
          }
        },
        "required": [
          "id",
          "feePercentage"
        ]
      },
      "OrganizationKind": {
        "type": "string",
        "enum": [
          "individual",
          "business"
        ]
      },
      "WithdrawalAddressMinimalDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Withdrawal address id"
          },
          "name": {
            "type": "string",
            "description": "Withdrawal address name"
          },
          "address": {
            "type": "string",
            "description": "Withdrawal address"
          },
          "chainId": {
            "type": "number",
            "example": 1,
            "description": "Withdrawal address chain id"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Is default withdrawal address"
          }
        },
        "required": [
          "id",
          "name",
          "address",
          "chainId",
          "isDefault"
        ]
      },
      "AddressDetailDto": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string"
          },
          "line2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        }
      },
      "OrganizationDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Organization's name"
          },
          "type": {
            "type": "string",
            "description": "Organization's type"
          },
          "status": {
            "description": "Organization's status",
            "$ref": "#/components/schemas/OrganizationStatus"
          },
          "kind": {
            "description": "Organization's kind",
            "$ref": "#/components/schemas/OrganizationKind"
          },
          "ownerId": {
            "type": "string",
            "description": "User's id who owns organization"
          },
          "noOfEmployees": {
            "type": "string",
            "description": "No of employees"
          },
          "monthlyPaymentVolume": {
            "type": "string",
            "description": "Monthly payment volume"
          },
          "addresses": {
            "description": "Withdrawal addresses",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WithdrawalAddressMinimalDto"
            }
          },
          "email": {
            "type": "string",
            "description": "Organization's email"
          },
          "supportEmail": {
            "type": "string",
            "description": "Organization's support email"
          },
          "phone": {
            "type": "string",
            "description": "Organization's support phone number"
          },
          "addressDetails": {
            "description": "Organization's business address",
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressDetailDto"
              }
            ]
          },
          "brandLogo": {
            "type": "string",
            "description": "Brand logo url"
          },
          "brandColor": {
            "type": "string",
            "description": "Brand color in hex format"
          },
          "supportUrl": {
            "type": "string",
            "description": "Organization's support url"
          },
          "termsUrl": {
            "type": "string",
            "description": "Organization's terms and conditions url"
          },
          "privacyUrl": {
            "type": "string",
            "description": "Organization's privacy policy url"
          },
          "websiteUrl": {
            "type": "string",
            "description": "Organization's website url"
          },
          "featureAccessRequests": {
            "description": "Feature access requests from organization",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "companyIdentificationNumber": {
            "type": "string"
          },
          "taxIdentificationNumber": {
            "type": "string"
          },
          "referralCode": {
            "type": "string",
            "description": "Referral code"
          },
          "referrerId": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "type",
          "status",
          "kind",
          "ownerId",
          "noOfEmployees",
          "monthlyPaymentVolume",
          "addresses",
          "brandLogo",
          "brandColor",
          "featureAccessRequests"
        ]
      },
      "UserDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "profilePicture": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "position": {
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/UserStatus"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "flags": {
            "$ref": "#/components/schemas/UserFlagsDto"
          }
        },
        "required": [
          "id",
          "firstName",
          "lastName",
          "role",
          "status"
        ]
      },
      "WithdrawalAddressDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Withdrawal address id"
          },
          "name": {
            "type": "string",
            "description": "Withdrawal address name"
          },
          "address": {
            "type": "string",
            "description": "Withdrawal address"
          },
          "chainId": {
            "type": "number",
            "example": 1,
            "description": "Withdrawal address chain id"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Is default withdrawal address"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "Withdrawal address creation date"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string",
            "description": "Withdrawal address update date"
          }
        },
        "required": [
          "id",
          "name",
          "address",
          "chainId",
          "isDefault",
          "createdAt",
          "updatedAt"
        ]
      },
      "DateFilterDto": {
        "type": "object",
        "properties": {
          "isnull": {
            "type": "boolean",
            "description": "Returns null values"
          },
          "notnull": {
            "type": "boolean",
            "description": "Returns not null values"
          },
          "gt": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values greater than the given date"
          },
          "gte": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values greater than or equal to the given date"
          },
          "lt": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values less than the given date"
          },
          "lte": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values less than or equal to the given date"
          }
        }
      },
      "PaginationFilterDto": {
        "type": "object",
        "properties": {
          "page": {
            "type": "number",
            "minimum": 1,
            "example": 1,
            "default": 1,
            "description": "Page number. Starts from 1"
          },
          "limit": {
            "type": "number",
            "minimum": 1,
            "maximum": 200,
            "example": 10,
            "default": 200,
            "description": "Number of items per page"
          },
          "createdAt": {
            "description": "Filter by created date",
            "example": {
              "gt": "2020-01-01"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/DateFilterDto"
              }
            ]
          }
        }
      },
      "PageDto": {
        "type": "object",
        "properties": {
          "page": {
            "type": "number",
            "example": 1,
            "default": 1,
            "description": "Page number. Starts from 1"
          },
          "limit": {
            "type": "number",
            "example": 10,
            "default": 200,
            "description": "Number of items per page"
          },
          "count": {
            "type": "number",
            "example": 1
          },
          "hasMore": {
            "type": "boolean"
          },
          "query": {
            "$ref": "#/components/schemas/PaginationFilterDto"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "required": [
          "page",
          "limit",
          "count",
          "hasMore",
          "data"
        ]
      },
      "PersonalAccessTokenWithPlainTokenDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "tokenIdentifier": {
            "type": "string"
          },
          "organizationId": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "token": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "tokenIdentifier",
          "organizationId",
          "userId",
          "createdAt",
          "updatedAt",
          "token"
        ]
      },
      "AccountOnboardResponseDto": {
        "type": "object",
        "properties": {
          "organization": {
            "description": "Organization details",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrganizationDto"
              }
            ]
          },
          "user": {
            "description": "User details",
            "allOf": [
              {
                "$ref": "#/components/schemas/UserDto"
              }
            ]
          },
          "paymentSetting": {
            "description": "Organization payment setting details",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentSettingDto"
              }
            ]
          },
          "webhookEndpoints": {
            "description": "Organization webhook endpoints",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AddressDetailDto"
            }
          },
          "withdrawalAddresses": {
            "description": "Organization withdrawal addresses",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WithdrawalAddressDto"
            }
          },
          "personalAccessToken": {
            "description": "Organization personal access token to access organization' API",
            "allOf": [
              {
                "$ref": "#/components/schemas/PersonalAccessTokenWithPlainTokenDto"
              }
            ]
          }
        },
        "required": [
          "organization",
          "user",
          "paymentSetting",
          "webhookEndpoints",
          "withdrawalAddresses",
          "personalAccessToken"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 181,
      "2": 177,
      "3": 27,
      "4": 23,
      "5": 171,
      "6": 139,
      "7": 0,
      "8": 127,
      "9": 93,
      "10": 212,
      "11": 76
    }
  }
}
```