# List all senders in project

Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned.

Endpoint: GET /v1/projects/{projectId}/whatsapp/senders
Version: 1.2.91
Security: BasicAuth, BearerAuth, OAuth2Production

## Path parameters:

  - `projectId` (string, required)
    The unique ID of the project. You can find this on the Sinch Dashboard.

## Query parameters:

  - `pageToken` (string)
    The page token if retrieving the next page from a previous query.

  - `pageSize` (number)
    The page size requested.

  - `filterStates` (array)
    Optionally query for sender by states.
    Enum: "ACTIVE", "IN_PROGRESS", "INACTIVE", "PENDING_VERIFICATION", "SUSPENDED", "ERROR"

  - `filterStatuses` (array)
    Optionally query for sender by statuses.
    Enum: "DRAFT", "ERROR", "IN_PROGRESS", "MULTIPLE_WABA_ERROR", "REJECTED"

## Response 200 fields (application/json):

  - `totalSize` (number, required)
    Total size of the entries matching the search query.

  - `pageSize` (number, required)
    Requested size of the page.

  - `senders` (array, required)

  - `senders.id` (string, required)
    The unique ID of the sender.

  - `senders.region` (string, required)
    Region sender is provisioned in.
    Enum: "BR", "EU", "US", "UNRECOGNIZED"

  - `senders.metaLocalStorage` (string, required)
    Region sender store the data in Meta.
    Enum: "AE", "AU", "BH", "BR", "CA", "CH", "DE", "GB", "ID", "IN", "JP", "KR", "SG", "US", "ZA", "UNRECOGNIZED", "UNSPECIFIED"

  - `senders.businessManager` (string, required)
    Business manager.
    Enum: "SINCH_AMERICA", "SINCH_BR", "SINCH_MX", "SINCH_SEP", "SINCH_UK", "UNRECOGNIZED"

  - `senders.compatibleRegions` (array, required)
    Conversation API app regions the sender can be used for.

  - `senders.state` (string)
    The current state of the sender.
    Enum: same as `filterStates` (6 values)

  - `senders.changes` (object)
    Any pending changes to the sender.

  - `senders.changes.status` (string, required)
    Current status of the pending changes.
    Enum: same as `filterStatuses` (5 values)

  - `senders.changes.details` (array) — one of:
    The pending changes to sender details and information
    - WhatsappSenderDetailsDto:
      - `displayName` (string, required)
        Sender display name within WhatsApp.
      - `vertical` (string, required)
        Category of the sender displayed in the Business Info within WhatsApp.
        Enum: "ALCOHOL", "AUTOMOTIVE", "BEAUTY_SPA_SALON", "CLOTHING_AND_APPAREL", "EDUCATION", "ENTERTAINMENT", "EVENT_PLANNING_AND_SERVICE", "FINANCE_AND_BANKING", "FOOD_AND_GROCERY", "HOTEL_AND_LODGING", "MEDICAL_AND_HEALTH", "NON_PROFIT", "NOT_SET", "ONLINE_GAMBLING", "OTC_DRUGS", "OTHER", "PHYSICAL_GAMBLING", "PROFESSIONAL_SERVICES", "PUBLIC_SERVICE", "RESTAURANT", "SHOPPING_AND_RETAIL", "TRAVEL_AND_TRANSPORTATION", "UNRECOGNIZED"
      - `description` (string)
        Description of the sender displayed in the Business Info within WhatsApp.
      - `email` (string)
        Contact email displayed in the Business Info within WhatsApp.
      - `address` (string)
        Business address displayed in the Business Info within WhatsApp.
      - `websiteOne` (string)
        Business website displayed in the Business Info within WhatsApp.
      - `websiteTwo` (string)
        Second business website displayed in the Business Info within WhatsApp.
      - `about` (string)
        About text displayed in the Business Info within WhatsApp.
  - Hyperlinks can be included but will not render as clickable links.
  - Markdown is not supported.
      - `photoUrl` (string)
        URL to the sender image displayed in WhatsApp.
- Supported mime types: image/jpeg, image/png or image/webp.
- Maximum file size: 5MB.
- Minimum image dimensions: 192 x 192 px.
- Maximum image dimensions: 640 x 640 px.
- Image will be cropped to maximum image dimensions.
- If you submit a PNG image with a transparent background, the background will be rendered as black.
      - `username` (string)
        WhatsApp Business username of the sender.
    - WhatsappSenderChangesDetailsDto:
      - `displayName` (string)
        Sender display name within WhatsApp.
      - `description` (string)
        Description of the sender displayed in the Business Info within WhatsApp.
      - `vertical` (string)
        Category of the sender displayed in the Business Info within WhatsApp.
        Enum: same as `vertical` in "WhatsappSenderDetailsDto" (23 values)
      - `email` (string)
        Contact email displayed in the Business Info within WhatsApp.
      - `address` (string)
        Business address displayed in the Business Info within WhatsApp.
      - `websiteOne` (string)
        Business website displayed in the Business Info within WhatsApp.
      - `websiteTwo` (string)
        Second business website displayed in the Business Info within WhatsApp.
      - `about` (string)
        About text displayed in the Business Info within WhatsApp.
  - Hyperlinks can be included but will not render as clickable links.
  - Markdown is not supported.
      - `photoUrl` (string)
        URL to the sender image displayed in WhatsApp.
- Supported mime types: image/jpeg, image/png or image/webp.
- Maximum file size: 5MB.
- Minimum image dimensions: 192 x 192 px.
- Maximum image dimensions: 640 x 640 px.
- Image will be cropped to maximum image dimensions.
- If you submit a PNG image with a transparent background, the background will be rendered as black.
      - `username` (string)
        WhatsApp Business username of the sender.

  - `senders.changes.errorReason` (string)
    Error reason if sender is in state ERROR.

  - `senders.changes.errorCode` (string)
    Error code if sender is in state ERROR.
    Enum: "CANNOT_ASSIGN_CREDIT_LINE", "CANNOT_ASSIGN_SYSTEM_USER", "CANNOT_CREATE_NEW_WHATSAPP_SENDER", "CANNOT_CREATE_WABA_FOR_BUSINESS", "CANNOT_GET_DETAILS_FOR_CLOUD_API", "CANNOT_GET_WABA_DETAILS", "CANNOT_REGISTER_NEW_WHATSAPP_SENDER", "CANNOT_REGISTER_TO_CLOUD_API", "CANNOT_SUBSCRIBE_TO_CLOUD_API", "CANNOT_SUBSCRIBE_TO_WEBHOOK", "DUPLICATES_ON_SENDER_PHONE_NUMBER", "FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES", "MULTIPLE_WABA_FOR_PROJECT_ID", "NO_CERTIFICATE_AVAILABLE", "NO_NOVA_ACCOUNT_ID", "NO_PRICING_PLAN", "NO_PROJECT_ID", "NO_VERIFIED_PHONE_NUMBER", "NOT_VERIFIED_REQUESTED_PHONE_NUMBER", "NOT_VERIFY_BUSINESS_VIA_WHATSAPP", "NOVA_ACCOUNT_ID_CONFLICT", "PROJECT_ID_CONFLICT", "SENDER_HAS_BEEN_DELETED", "WABA_CONNECTED_TO_ANOTHER_PROJECT", "UNKNOWN_ERROR", "UNRECOGNIZED"

  - `senders.details` (object)
    Sender details and information.

  - `senders.details.displayName` (string, required)
    Sender display name within WhatsApp.

  - `senders.details.vertical` (string, required)
    Category of the sender displayed in the Business Info within WhatsApp.
    Enum: same as `vertical` in "WhatsappSenderDetailsDto" (23 values)

  - `senders.details.description` (string)
    Description of the sender displayed in the Business Info within WhatsApp.

  - `senders.details.email` (string)
    Contact email displayed in the Business Info within WhatsApp.

  - `senders.details.address` (string)
    Business address displayed in the Business Info within WhatsApp.

  - `senders.details.websiteOne` (string)
    Business website displayed in the Business Info within WhatsApp.

  - `senders.details.websiteTwo` (string)
    Second business website displayed in the Business Info within WhatsApp.

  - `senders.details.about` (string)
    About text displayed in the Business Info within WhatsApp.
  - Hyperlinks can be included but will not render as clickable links.
  - Markdown is not supported.

  - `senders.details.photoUrl` (string)
    URL to the sender image displayed in WhatsApp.
- Supported mime types: image/jpeg, image/png or image/webp.
- Maximum file size: 5MB.
- Minimum image dimensions: 192 x 192 px.
- Maximum image dimensions: 640 x 640 px.
- Image will be cropped to maximum image dimensions.
- If you submit a PNG image with a transparent background, the background will be rendered as black.

  - `senders.details.username` (string)
    WhatsApp Business username of the sender.

  - `senders.metadata` (object)
    Data about the current state of individual sender fields.

  - `senders.metadata.username` (object)
    Approval status of the sender username.

  - `senders.metadata.username.status` (string, required)
    Current approval status of the field.
    Enum: "APPROVED", "DEFERRED", "DELETED", "EXPIRED", "PENDING", "REJECTED", "RESERVED", "UNRECOGNIZED", "UNSPECIFIED"

  - `senders.metadata.username.value` (string)
    Requested value of the field.

  - `senders.metadata.username.rejectionReason` (string)
    Reason for rejection if the field update was rejected.

  - `senders.conversationApiAppDetails` (object)
    If set, the details of the Conversation API App the sender is connected to.

  - `senders.conversationApiAppDetails.id` (string, required)
    ID of the app

  - `senders.conversationApiAppDetails.projectId` (string, required)
    ID of the app project

  - `senders.conversationApiAppDetails.region` (string, required)
    App region.
    Enum: same as `senders.region` (4 values)

  - `senders.conversationApiAppDetails.channelStatus` (string)
    Status of the channel credentials integration.
    Enum: "ACTIVE", "FAILING", "PENDING", "UNRECOGNIZED"

  - `senders.maxTps` (number)
    Maximum sender TPS.

  - `senders.qualityRating` (string)
    Current quality rating of the sender.
    Enum: "GREEN", "RED", "YELLOW", "UNKNOWN", "UNRECOGNIZED"

  - `senders.bearerToken` (string)
    Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App.

  - `senders.created` (string)
    The UTC Date Time in ISO 8601 for when the sender was created.

  - `senders.modified` (string)
    The UTC Date Time in ISO 8601 for when the sender was last modified.

  - `senders.countryCode` (string)
    Country code of sender phone number.

  - `senders.phoneNumber` (string)
    Sender phone number without country code.

  - `senders.numberProvider` (string)
    Provider for phone number.
    Enum: "CUSTOMER", "SINCH", "UNRECOGNIZED"

  - `senders.cloudApi` (boolean, required)
    True if the sender is hosted in WhatsApp Cloud API.

  - `senders.conversationApiApp` (string)
    If set, the Conversation API App ID the sender is connected to.

  - `senders.dailyLimit` (string)
    This property is deprecated. Use AccountDto.businessDailyLimit instead. Current daily message limit of the sender.
    Enum: "NOT_SET", "TIER_100K", "TIER_10K", "TIER_1K", "TIER_250", "TIER_2K", "TIER_50", "TIER_UNLIMITED", "UNRECOGNIZED"

  - `senders.wabaBanState` (string)
    Please use get account endpoint for this information.
    Enum: "DISABLE", "REINSTATE", "SCHEDULE_FOR_DISABLE", "UNRECOGNIZED"

  - `senders.wabaBanDate` (string)
    Please use get account endpoint for this information.

  - `previousPageToken` (string)
    Encoded token to use in list request to fetch previous batch of entries.

  - `nextPageToken` (string)
    Encoded token to use in list request to fetch next batch of entries.

## Response 400 fields (application/json):

  - `body` (ProjectNotInitializedErrorTitle (object) or InvalidPageTokenErrorTitle (object) or InvalidPageSizeErrorTitle (object) or InvalidFilterStatesErrorTitle (object) or InvalidFilterStatusesErrorTitle (object)) — one of:
    - ProjectNotInitializedErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "project_not_initialized"
      - `message` (string)
        Human readable message.
        Example: "Project not initialized for WhatsApp."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Verify that the project ID is correct and that it has been onboarded for WhatsApp."
    - InvalidPageTokenErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_page_token"
      - `message` (string)
        Human readable message.
        Example: "Invalid page token."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "The page token to use is provided in the previous query response, for new queries simply leave this field undefined."
    - InvalidPageSizeErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_page_size"
      - `message` (string)
        Human readable message.
        Example: "Page size must be numeric."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Use a integer value for pageSize parameter."
    - InvalidFilterStatesErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_filter_states"
      - `message` (string)
        Human readable message.
        Example: "Invalid filterStates."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Verify that the filterStates used are supported by the Provisioning API."
      - `additionalInformation` (object)
        Additional information for error.
        Example: {"supportedCodes":"ACTIVE, IN_PROGRESS, INACTIVE, PENDING_VERIFICATION, SUSPENDED, ERROR"}
    - InvalidFilterStatusesErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_filter_statuses"
      - `message` (string)
        Human readable message.
        Example: "Invalid filter statuses."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Verify that the filterStatuses used are supported by the Provisioning API."
      - `additionalInformation` (object)
        Additional information for error.
        Example: {"supportedCodes":"DRAFT, ERROR, IN_PROGRESS, REJECTED"}

## Response 401 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "unauthorized_error"

  - `message` (string)
    Human readable message.
    Example: "Unauthorized error."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Verify that projectId is correct."

## Response 404 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "sender_not_found"

  - `message` (string)
    Human readable message.
    Example: "Sender not found."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Verify that the parameters are correct."

## Response 500 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "internal_error"

  - `message` (string)
    Human readable message.
    Example: "Internal server error."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Please wait and try again, if the error persist please contact support."