# BatchGetProfile
<a name="API_connect-customer-profiles_BatchGetProfile"></a>

Get a batch of profiles.

## Request Syntax
<a name="API_connect-customer-profiles_BatchGetProfile_RequestSyntax"></a>

```
POST /domains/DomainName/batch-get-profiles HTTP/1.1
Content-type: application/json

{
   "ProfileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_BatchGetProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_BatchGetProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ProfileIds](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-request-ProfileIds"></a>
List of unique identifiers for customer profiles to retrieve.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_BatchGetProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "Code": "string",
         "Message": "string",
         "ProfileId": "string"
      }
   ],
   "Profiles": [ 
      { 
         "AccountNumber": "string",
         "AdditionalInformation": "string",
         "Address": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "Attributes": { 
            "string" : "string" 
         },
         "BillingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "BirthDate": "string",
         "BusinessEmailAddress": "string",
         "BusinessName": "string",
         "BusinessPhoneNumber": "string",
         "EmailAddress": "string",
         "EngagementPreferences": { 
            "Email": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ],
            "Phone": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ]
         },
         "FirstName": "string",
         "FoundByItems": [ 
            { 
               "KeyName": "string",
               "Values": [ "string" ]
            }
         ],
         "Gender": "string",
         "GenderString": "string",
         "HomePhoneNumber": "string",
         "LastName": "string",
         "MailingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "MiddleName": "string",
         "MobilePhoneNumber": "string",
         "PartyType": "string",
         "PartyTypeString": "string",
         "PersonalEmailAddress": "string",
         "PhoneNumber": "string",
         "ProfileId": "string",
         "ProfileType": "string",
         "ShippingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_BatchGetProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Errors](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-response-Errors"></a>
For information about the errors that are common to all actions, see [Common Errors](https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html).  
Type: Array of [BatchGetProfileError](API_connect-customer-profiles_BatchGetProfileError.md) objects

 ** [Profiles](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-response-Profiles"></a>
Array of Profile Objects.  
Type: Array of [Profile](API_connect-customer-profiles_Profile.md) objects

## Errors
<a name="API_connect-customer-profiles_BatchGetProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_BatchGetProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/BatchGetProfile)