# ListProfiles

Returns a paged list of profiles.

`GET /api/v2/profiles`

**API:** AFC SaaS Pro REST v2
**Tag:** Customizations
**API Version:** v2
**Authentication:** Basic (username + license key) or Bearer token

Source: https://developer.avalara.com/products/communications/api/v2/methods/Customizations/ListProfiles/

## Description

QueryOptions

  
    
      `filter` — OData-style filter expression. Use the filterable properties and operators below.
  
  
    
      `orderby` — Sort expression; one or more sortable properties with optional `asc` or `desc`.
  
  
    
      `skip` — Number of items to skip (paging).
  
  
    
      `top` — Number of items to return per page.
  
  
    
      `count` — When true, includes the total filtered count in the response.
  
  
    
      `countOnly` — When true, returns only the total filtered count, no results.
  


Filter options and operators by property

  
    Property
    Type and allowed operators
  
  
    
      `TenantId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `Name`
    
    string: `eq`, `ne`, `in`, `contains`, `startswith`, `endswith`
  
  
    
      `Number`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `BundlePackageId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `ExclusionCollectionId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `OverrideGroupId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `SafeHarborOverrideSettingsId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  
  
    
      `TaxCalculationSettingsId`
    
    numeric: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `in`
  


Sort keys (use in `orderby`): `Name`, `Number`, `BundlePackageId`, `ExclusionCollectionId`, `OverrideGroupId`, `SafeHarborOverrideSettingsId`, `TaxCalculationSettingsId`, `CreatedBy`, `CreatedDate`, `UpdatedBy`, `UpdatedDate`.

Examples

  
    
      `?filter=Name eq 'Profile1'`
    
  
  
    
      `?filter=BundlePackageId eq 5` and `Number in (1,2,3)`
  
  
    
      `?filter=ExclusionCollectionId eq 5` and `Number in (1,2,3)`
  
  
    
      `?orderby=Number asc,CreatedDate desc`
    
  
  
    
      `?skip=0&top=20&count=true`

## Parameters

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `client_id` | integer | header | Yes | The client id. |
| `Filter` | string | query | No | The filter expression. |
| `OrderBy` | string | query | No | The sort expression. |
| `Skip` | integer | query | No | The number of items to skip. |
| `Top` | integer | query | No | The number of items to return. |
| `Count` | boolean | query | No | A flag indicating the filtered, unpaged, count should be returned in the response. |
| `CountOnly` | boolean | query | No | A flag indicating only the filtered, unpaged, count should be returned in the response, without the actual results. |

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | A paged list of Avalara.CommsPlatform.Web.Rest.Application.Profiles.DTOs.ProfileDto. | `PagedListProfileDto` |
| 400 | Bad Request | `ProblemDetails` |
| 404 | A problem details. |  |

### 200 Response: `PagedListProfileDto`

A generic paged list.

| Property | Type | Required | Description |
|---|---|---|---|
| `value` | ProfileDto[] | No | The values of the paged list. |
| `recordsetCount` | integer | No | The count of the un-paged, but filtered, records. |