# 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}/rcs/senders
Version: 1.2.16
Security: BasicAuth, BearerAuth

## 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.

  - `filterConversationApiAppId` (string)
    Optional query for sender by Conversation API app id.

  - `filterSenderIds` (string)
    Optional query for sender by sender ids.

  - `filterSenderName` (string)
    Optional query for sender by name.

  - `filterStates` (array)
    Optionally query for sender by states.
    Enum: "DRAFT", "IN_PROGRESS", "IN_TEST", "LAUNCHED", "LAUNCHING", "PREPARING_LAUNCH", "UNLAUNCHED", "UNKNOWN"

  - `sortColumn` (string)
    Optional query for sender sort column.
    Enum: "CREATED", "MODIFIED", "NAME", "STATE"

  - `sortDirection` (string)
    Optional query for sender sort direction.
    Enum: "ASC", "DESC"

## 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)
    List of senders.

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

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

  - `senders.billingCategory` (string, required)
    Billing category.
    Enum: "BASIC_MESSAGE", "CONVERSATIONAL", "CONVERSATIONAL_LEGACY", "SINGLE_MESSAGE"

  - `senders.useCase` (string, required)
    Use case.
    Enum: "MULTIUSE", "OTP", "PROMOTIONAL", "TRANSACTIONAL"

  - `senders.hostingRegion` (string, required)
    Internal Google hosting region
    Enum: "ASIA_PACIFIC", "EUROPE", "NORTH_AMERICA"

  - `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: "BR", "EU", "US", "UNRECOGNIZED"

  - `senders.state` (string)
    The current state of the sender.
    Enum: "DRAFT", "IN_PROGRESS", "IN_TEST", "LAUNCHED", "LAUNCHING", "PREPARING_LAUNCH", "UNLAUNCHED", "UNKNOWN"

  - `senders.testNumberStates` (array)
    Test phone numbers states.

  - `senders.testNumberStates.number` (string, required)
    Test phone number.

  - `senders.testNumberStates.state` (string, required)
    Test phone state.
    Enum: "DECLINED", "INVALID", "PENDING", "UNVERIFIED", "VERIFIED", "UNRECOGNIZED"

  - `senders.testNumberStates.submitted` (string, required)
    Date of submitting phone number.

  - `senders.countryStatus` (array)
    Countries status.

  - `senders.countryStatus.country` (string, required)
    Two-letter country code in ISO 3166 standard.
    Enum: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "UNRECOGNIZED"

  - `senders.countryStatus.status` (string, required)
    Country status.
    Enum: "LAUNCHED", "NOT_LAUNCHED", "PENDING", "PENDING_UNLAUNCHED", "REJECTED", "SUSPENDED", "UNLAUNCHED", "INVALID_IN_GOOGLE_MY_BUSINESS", "UNRECOGNIZED"

  - `senders.countryStatus.operators` (array, required)
    Mobile network operators.

  - `senders.countryStatus.operators.name` (string, required)
    Operator name.

  - `senders.countryStatus.operators.status` (string, required)
    Operator status.
    Enum: "LAUNCHED", "NOT_LAUNCHED", "PENDING", "PENDING_UNLAUNCHED", "REJECTED", "SUSPENDED", "UNLAUNCHED", "INVALID_IN_GOOGLE_MY_BUSINESS", "UNRECOGNIZED"

  - `senders.countryStatus.operators.remark` (string)
    Any comments or notes to the current state.

  - `senders.countryStatus.operators.modified` (string)
    Last date the operator changed state.

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

  - `senders.details.questionnaire` (object, required)
    Launch questionnaire.

  The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.

  - `senders.details.questionnaire.general` (object, required)
    General launch questions

  - `senders.details.questionnaire.general.questions` (object, required)
    Launch questions

  - `senders.details.questionnaire.general.questions.optInDescription` (object, required)
    How you obtain opt-in to message users.

  - `senders.details.questionnaire.general.questions.optInDescription.question` (string, required)
    Human readable question.

  - `senders.details.questionnaire.general.questions.optInDescription.suggestedAnswers` (array, required)
    Suggested answers to the question.

  - `senders.details.questionnaire.general.questions.triggerDescription` (object, required)
    Actions that triggers messages to users.

  - `senders.details.questionnaire.general.questions.interactionsDescription` (object, required)
    Interactions with users.

  - `senders.details.questionnaire.general.questions.optOutDescription` (object, required)
    The message the sender sends when a user opts out.

  - `senders.details.questionnaire.general.questions.videoUris` (object, required)
    Publicly available URIs for videos of the sender, for review purposes only.

  - `senders.details.questionnaire.general.questions.screenshotUris` (object, required)
    Publicly available URIs for screenshots of the sender, for review purposes only.

  - `senders.details.questionnaire.general.answers` (object, required)
    Launch answers

  - `senders.details.questionnaire.general.answers.optInDescriptionMetadata` (object)
    Metadata for specified answer.

  - `senders.details.questionnaire.general.answers.optInDescriptionMetadata.ignore` (string)
    Ignore given string on launch, e.g. custom delimiter.

  - `senders.details.questionnaire.general.answers.triggerDescriptionMetadata` (object)
    Metadata for specified answer.

  - `senders.details.questionnaire.general.answers.interactionsDescriptionMetadata` (object)
    Metadata for specified answer.

  - `senders.details.questionnaire.general.answers.optOutDescriptionMetadata` (object)
    Metadata for specified answer.

  - `senders.details.questionnaire.verification` (object, required)
    Verification questions.

  - `senders.details.questionnaire.verification.questions` (object, required)
    Verification questions.

  - `senders.details.questionnaire.verification.questions.name` (object, required)
    Name of verification contact.

  - `senders.details.questionnaire.verification.questions.email` (object, required)
    Email of verification contact.

  - `senders.details.questionnaire.verification.questions.title` (object, required)
    Title of verification contact.

  - `senders.details.questionnaire.verification.questions.website` (object, required)
    Website of verification contact.

  - `senders.details.questionnaire.verification.answers` (object, required)
    Verification answers.

  - `senders.details.questionnaire.gb` (object)
    Launch questions specific for UK.

  - `senders.details.questionnaire.gb.questions` (object, required)
    Launch questions specific for UK.

  - `senders.details.questionnaire.gb.questions.brandIndustry` (object, required)
    Sector or industry of business.

  - `senders.details.questionnaire.gb.questions.companyLegalName` (object, required)
    The registered legal name of the company.

  - `senders.details.questionnaire.gb.questions.companyRegistrationNumber` (object, required)
    The company registration number.

  - `senders.details.questionnaire.gb.questions.fullCompanyAddress` (object, required)
    Full company address.

  - `senders.details.questionnaire.gb.questions.messagesVolume` (object, required)
    Messages volume.

  - `senders.details.questionnaire.gb.questions.messagesFrequency` (object, required)
    Messages frequency.

  - `senders.details.questionnaire.gb.questions.campaignLength` (object, required)
    Length of campaign.

  - `senders.details.questionnaire.gb.answers` (object, required)
    Launch answers specific for UK.

  - `senders.details.questionnaire.gb.answers.fullCompanyAddressMetadata` (object)
    Metadata for specified answer.

  - `senders.details.questionnaire.fr` (object)
    Launch questions specific for France.

  - `senders.details.questionnaire.fr.questions` (object, required)
    Launch questions specific for France.

  - `senders.details.questionnaire.fr.questions.siren` (object, required)
    Company directory identification system number.

  - `senders.details.questionnaire.fr.questions.usersAmount` (object)
    No longer required - Will be removed end of August 2025.

  - `senders.details.questionnaire.fr.questions.startDate` (object)
    No longer required - Will be removed end of August 2025.

  - `senders.details.questionnaire.fr.answers` (object, required)
    Launch answers specific for France.

  - `senders.details.questionnaire.es` (object)
    Launch questions specific for Spain.

  - `senders.details.questionnaire.es.questions` (object, required)
    Launch questions specific for Spain.

  - `senders.details.questionnaire.es.questions.firstMessage` (object, required)
    The first message sent from the sender to the user.

  - `senders.details.questionnaire.es.answers` (object, required)
    Launch answers specific for Spain.

  - `senders.details.questionnaire.us` (object)
    Launch questions specific for US.

  - `senders.details.questionnaire.us.questions` (object, required)
    Launch questions specific for US.

  - `senders.details.questionnaire.us.questions.ein` (object, required)
    Employer Identification Number (EIN) nine-digit number assigned by IRS, following format: XX-XXXXXXX.

  - `senders.details.questionnaire.us.questions.smsCampaign` (object, required)
    US SMS campaign used as fallback.

  - `senders.details.questionnaire.us.answers` (object, required)
    Launch answers specific for US.

  - `senders.details.brand` (object)
    Brand information.

  - `senders.details.brand.name` (string)
    Brand name.

  - `senders.details.brand.emails` (array)
    Contact emails.

  - `senders.details.brand.emails.label` (string, required)
    Contact email label.

  - `senders.details.brand.emails.address` (string, required)
    Contact email address.

  - `senders.details.brand.phones` (array)
    Contact phone numbers.

  - `senders.details.brand.phones.label` (string, required)
    Contact phone label.

  - `senders.details.brand.phones.number` (array, required)
    Contact phone number.

  - `senders.details.brand.websites` (array)
    Contact websites.

  - `senders.details.brand.websites.label` (string, required)
    Contact website label.

  - `senders.details.brand.websites.url` (string, required)
    Contact website address.

  - `senders.details.brand.color` (string)
    Brand color (HEX code).

  - `senders.details.brand.description` (string)
    Brand description.

  - `senders.details.brand.bannerUrl` (string)
    Brand banner url.

  - `senders.details.brand.logoUrl` (string)
    Brand logo url.

  - `senders.details.brand.privacyPolicyUrl` (string)
    Privacy Policy URL.

  - `senders.details.brand.termsOfServiceUrl` (string)
    Terms & Conditions URL.

  - `senders.details.testNumbers` (array)
    Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.

  - `senders.details.countries` (array)
    List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.
    Enum: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "UNRECOGNIZED"

  - `senders.details.callbackUrl` (string)
    Use Webhooks instead for sender update events.

  - `senders.authName` (string)
    The name is needed to connect the sender to a Conversation API App.

  - `senders.authToken` (string)
    The 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.supplierDetails` (object)
    Supplier details.

  - `senders.supplierDetails.google` (object)
    Google supplier details.

  - `senders.supplierDetails.google.agentId` (string)
    Google agent id.

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

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

  - `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 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 403 fields (application/json):

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

  - `message` (string)
    Human readable message.
    Example: "RBM has not been used."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Please wait and try again or reach out to support at si-richmessaging@sinch.com"

## Response 429 fields (application/json):

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

  - `message` (string)
    Human readable message.
    Example: "RCS Business Messaging too many requests."

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

## 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."