--- title: "List all senders in project" method: GET path: "/v1/projects/{projectId}/whatsapp/senders" tags: ["WhatsApp Senders"] --- # List all senders in project `GET /v1/projects/{projectId}/whatsapp/senders` Returns a paginated list of senders for the specified project. If no page token is supplied then the first `50` will be returned. ## Path parameters - `projectId` string, required ## Query parameters - `pageToken` string - `pageSize` number - `filterStates` string[] - `filterStatuses` string[] ## Response `200` List of senders - WhatsappSenderListDto - `totalSize` number, required — Total size of the entries matching the search query. - `pageSize` number, required — Requested size of the page. - `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. - `senders` WhatsappSenderDto[], required - `id` string, required — The unique ID of the sender. - `state` 'ACTIVE' | 'IN_PROGRESS' | 'INACTIVE' | 'PENDING_VERIFICATION' | 'SUSPENDED' | 'ERROR' — The current state of the sender. - `changes` WhatsappSenderChangesDto - `status` 'DRAFT' | 'ERROR' | 'IN_PROGRESS' | 'MULTIPLE_WABA_ERROR' | 'REJECTED', required — Current status of the pending changes. - `details` union — The pending changes to sender details and information - object - `displayName` string, required — Sender display name within WhatsApp. - `description` string — Description of the sender displayed in the Business Info within WhatsApp. - `vertical` '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', required — Category 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. - object - `displayName` string — Sender display name within WhatsApp. - `description` string — Description of the sender displayed in the Business Info within WhatsApp. - `vertical` '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' — Category 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. - `errorReason` string — Error reason if sender is in state `ERROR`. - `errorCode` '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' — Error code if sender is in state `ERROR`. - `details` WhatsappSenderDetailsDto - `displayName` string, required — Sender display name within WhatsApp. - `description` string — Description of the sender displayed in the Business Info within WhatsApp. - `vertical` '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', required — Category 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. - `metadata` WhatsappSenderMetadataDto - `displayName` WhatsappSenderMetadataFieldDto - `value` string — Requested value of the field. - `status` 'APPROVED' | 'DEFERRED' | 'DELETED' | 'EXPIRED' | 'PENDING' | 'REJECTED' | 'RESERVED' | 'UNRECOGNIZED' | 'UNSPECIFIED', required — Current approval status of the field. - `rejectionReason` string — Reason for rejection if the field update was rejected. - `username` WhatsappSenderMetadataFieldDto - `value` string — Requested value of the field. - `status` 'APPROVED' | 'DEFERRED' | 'DELETED' | 'EXPIRED' | 'PENDING' | 'REJECTED' | 'RESERVED' | 'UNRECOGNIZED' | 'UNSPECIFIED', required — Current approval status of the field. - `rejectionReason` string — Reason for rejection if the field update was rejected. - `region` 'BR' | 'EU' | 'US' | 'UNRECOGNIZED', required — Region sender is provisioned in. - `metaLocalStorage` 'AE' | 'AU' | 'BH' | 'BR' | 'CA' | 'CH' | 'DE' | 'GB' | 'ID' | 'IN' | 'JP' | 'KR' | 'SG' | 'US' | 'ZA' | 'UNRECOGNIZED' | 'UNSPECIFIED', required — Region sender store the data in Meta. - `conversationApiApp` string — If set, the Conversation API App ID the sender is connected to. - `conversationApiAppDetails` WhatsappConversationApiAppDto - `id` string, required — ID of the app - `projectId` string, required — ID of the app project - `region` 'BR' | 'EU' | 'US' | 'UNRECOGNIZED', required — App region. - `channelStatus` 'ACTIVE' | 'FAILING' | 'PENDING' | 'UNRECOGNIZED' — Status of the channel credentials integration. - `maxTps` number — Maximum sender TPS. - `qualityRating` 'GREEN' | 'RED' | 'YELLOW' | 'UNKNOWN' | 'UNRECOGNIZED' — Current quality rating of the sender. - `dailyLimit` 'NOT_SET' | 'TIER_100K' | 'TIER_10K' | 'TIER_1K' | 'TIER_250' | 'TIER_2K' | 'TIER_50' | 'TIER_UNLIMITED' | 'UNRECOGNIZED' — This property is deprecated. Use `AccountDto.businessDailyLimit` instead. Current daily message limit of the sender. - `bearerToken` string — Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App. - `cloudApi` boolean, required — True if the sender is hosted in WhatsApp Cloud API. - `created` string — The UTC Date Time in ISO 8601 for when the sender was created. - `modified` string — The UTC Date Time in ISO 8601 for when the sender was last modified. - `countryCode` string — Country code of sender phone number. - `phoneNumber` string — Sender phone number without country code. - `numberProvider` 'CUSTOMER' | 'SINCH' | 'UNRECOGNIZED' — Provider for phone number. - `businessManager` 'SINCH_AMERICA' | 'SINCH_BR' | 'SINCH_MX' | 'SINCH_SEP' | 'SINCH_UK' | 'UNRECOGNIZED', required — Business manager. - `wabaBanState` 'DISABLE' | 'REINSTATE' | 'SCHEDULE_FOR_DISABLE' | 'UNRECOGNIZED' — Please use get account endpoint for this information. - `wabaBanDate` string — Please use get account endpoint for this information. - `compatibleRegions` string[], required — Conversation API app regions the sender can be used for. ## Other responses - `400` — BadRequest - `401` — Unauthorized - `404` — NotFound - `500` — InternalServerError --- [API](https://skmtc.net/sinch/apis/provisioning-api.md) · [All operations](https://skmtc.net/sinch/apis/provisioning-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/provisioning-api/revisions/c78a716de420/schema)