# Gets all known WhatsApp sandbox profiles.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1",
    "title": "Channels API"
  },
  "paths": {
    "/channels/v1/accounts/{accountId}/whatsapp/sandbox/profiles": {
      "get": {
        "tags": [
          "WhatsApp"
        ],
        "summary": "Gets all known WhatsApp sandbox profiles.",
        "operationId": "WhatsApp_GetSandboxProfilesAsync",
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "description": "The account identifier.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "The search query.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "description": "The skip.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "take",
            "in": "query",
            "description": "The take.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileBase"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileBase"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.cm.com"
    }
  ],
  "components": {
    "schemas": {
      "CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileBase": {
        "required": [
          "id",
          "accountId",
          "isActive",
          "isOtpProcessed",
          "isOtpSent",
          "isPending",
          "isSandbox",
          "metaBusinessUsername",
          "createdOnUtc"
        ],
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "accountId": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "isFacebookEmbeddedSignUpImport": {
            "type": "boolean"
          },
          "metaId": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "isActive": {
            "type": "boolean"
          },
          "isOtpProcessed": {
            "type": "boolean"
          },
          "isOtpSent": {
            "type": "boolean"
          },
          "isPending": {
            "type": "boolean"
          },
          "isSandbox": {
            "type": "boolean"
          },
          "metaQualityRating": {
            "$ref": "#/components/schemas/CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaQualityRating"
          },
          "metaBusinessUsername": {
            "$ref": "#/components/schemas/CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaBusinessUsername"
          },
          "fulfilledOnUtc": {
            "format": "date-time",
            "type": "string"
          },
          "createdOnUtc": {
            "format": "date-time",
            "type": "string"
          },
          "rejectedOnUtc": {
            "format": "date-time",
            "type": "string"
          },
          "cancelledOnUtc": {
            "format": "date-time",
            "type": "string"
          },
          "deletedOnUtc": {
            "format": "date-time",
            "type": "string"
          },
          "entityStatus": {
            "enum": [
              "ACTIVE",
              "PENDING",
              "ELIGIBLE",
              "NOT_VALIDATED",
              "CUSTOMER_ACTION_REQUIRED",
              "EXPIRED",
              "REJECTED",
              "CANCELLED",
              "DELETED"
            ],
            "type": "string"
          }
        }
      },
      "CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaQualityRating": {
        "type": "object",
        "properties": {
          "rating": {
            "type": "string"
          },
          "currentLimit": {
            "$ref": "#/components/schemas/CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaQualityRatingLimit"
          },
          "dailyConversationLimit": {
            "format": "int64",
            "type": "integer"
          },
          "restrictionHistory": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CM.Platform.Channels.Models.External.MetaCallbacks.ApiMetaCallbackWhatsAppBusinessAccountUpdateRestriction"
              }
            }
          }
        }
      },
      "CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaBusinessUsername": {
        "required": [
          "status"
        ],
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "UNKNOWN",
              "APPROVED",
              "RESERVED",
              "DELETED"
            ],
            "type": "string"
          },
          "username": {
            "type": "string"
          }
        }
      },
      "CM.Platform.Channels.Models.ChannelTypes.WhatsApp.ApiWhatsAppProfileMetaQualityRatingLimit": {
        "type": "object",
        "properties": {
          "fallbackLimit": {
            "type": "string"
          },
          "officialLimit": {
            "enum": [
              "TIER_50",
              "TIER_250",
              "TIER_1K",
              "TIER_10K",
              "TIER_100K",
              "TIER_UNLIMITED"
            ],
            "type": "string"
          }
        }
      },
      "CM.Platform.Channels.Models.External.MetaCallbacks.ApiMetaCallbackWhatsAppBusinessAccountUpdateRestriction": {
        "type": "object",
        "properties": {
          "restriction_type": {
            "type": "string"
          },
          "expiration": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 190,
      "2": 212,
      "3": 166,
      "4": 50,
      "5": 7,
      "6": 123,
      "7": 0,
      "8": 17,
      "9": 137,
      "10": 237,
      "11": 0
    }
  }
}
```