> ## Documentation Index > Fetch the complete documentation index at: https://docs.provisionapp.io/llms.txt > Use this file to discover all available pages before exploring further. # List clients > List the clients belonging to the partner the API key belongs to. Supports pagination (`limit`, `offset`), full-text `search`, `filters` (a URL-encoded JSON array of `{ attribute, operator, value }` conditions over the supported client fields), `sort`, and `include` to expand related resources. Requires the `client:read` scope. ## OpenAPI ````yaml /openapi.yaml get /v1/client/list openapi: 3.1.0 info: title: ProVision Public API version: 1.0.0 description: >- Use the ProVision Public API to integrate with ProVision conversations, clients, users, and addresses. All endpoints accept and return JSON, are authenticated with an `x-api-key` header, and are scoped to a single partner tenant. contact: email: support@onevisionresources.com name: OneVision Resources Support license: name: Proprietary servers: - url: https://connect.provisionapp.io description: Production security: [] paths: /v1/client/list: get: tags: - client summary: List clients description: >- List the clients belonging to the partner the API key belongs to. Supports pagination (`limit`, `offset`), full-text `search`, `filters` (a URL-encoded JSON array of `{ attribute, operator, value }` conditions over the supported client fields), `sort`, and `include` to expand related resources. Requires the `client:read` scope. operationId: listClients parameters: - schema: type: integer minimum: 1 maximum: 100 default: 20 required: false name: limit in: query - schema: type: - integer - 'null' minimum: 0 default: 0 required: false name: offset in: query - schema: type: string required: false name: search in: query - schema: type: string required: false name: include in: query - schema: type: string description: >- A URL-encoded JSON array of filter conditions, all AND-ed together. Each condition is `{ "attribute", "operator", "value", "valueType"? }`. Allowed attributes: id, firstName, lastName, marketingOptOut, createdAt, updatedAt, email, phoneNumber. Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >, >=, is_null, is_not_null. `value` is always a string; set `valueType` (one of boolean, number, number[], string, string[]) to coerce it — e.g. `"boolean"` for a true/false attribute or `"string[]"` for the `in` operator. required: false description: >- A URL-encoded JSON array of filter conditions, all AND-ed together. Each condition is `{ "attribute", "operator", "value", "valueType"? }`. Allowed attributes: id, firstName, lastName, marketingOptOut, createdAt, updatedAt, email, phoneNumber. Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >, >=, is_null, is_not_null. `value` is always a string; set `valueType` (one of boolean, number, number[], string, string[]) to coerce it — e.g. `"boolean"` for a true/false attribute or `"string[]"` for the `in` operator. name: filters in: query examples: equals: summary: Exact match value: '[{"attribute":"id","operator":"=","value":"example"}]' anyOf: summary: Match any of several values (`in`) value: >- [{"attribute":"id","operator":"in","value":"a,b,c","valueType":"string[]"}] contains: summary: Case-insensitive contains (`ilike`) value: '[{"attribute":"id","operator":"ilike","value":"%term%"}]' isSet: summary: Attribute is not null (`is_not_null`) value: '[{"attribute":"id","operator":"is_not_null","value":""}]' dateRange: summary: Range — multiple conditions are AND-ed value: >- [{"attribute":"createdAt","operator":">=","value":"2026-01-01T00:00:00.000Z"},{"attribute":"createdAt","operator":"<=","value":"2026-12-31T23:59:59.000Z"}] - schema: type: string description: >- Comma-separated list of fields to sort by, applied in order; prefix a field with `-` for descending. Allowed fields: firstName, lastName, marketingOptOut, createdAt, updatedAt. required: false description: >- Comma-separated list of fields to sort by, applied in order; prefix a field with `-` for descending. Allowed fields: firstName, lastName, marketingOptOut, createdAt, updatedAt. name: sort in: query examples: descending: summary: Single field, descending value: '-firstName' multiple: summary: Multiple keys (first descending, then ascending) value: '-firstName,lastName' responses: '200': description: Paginated list of clients content: application/json: schema: $ref: '#/components/schemas/ClientList' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - OpenApiKeyAuth: [] components: schemas: ClientList: type: object properties: data: type: array items: $ref: '#/components/schemas/Client' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta ErrorResponse: type: object properties: error: $ref: '#/components/schemas/ApiError' required: - error Client: type: object properties: id: $ref: '#/components/schemas/ClientId' partnerName: type: string name: type: string firstName: type: string lastName: type: string marketingOptOut: type: boolean emails: type: array items: $ref: '#/components/schemas/ClientEmail' phoneNumbers: type: array items: $ref: '#/components/schemas/ClientPhoneNumber' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - firstName - lastName - createdAt additionalProperties: false PaginationMeta: type: object properties: total: type: integer description: Total number of matching records limit: type: integer description: Page size used for this response offset: type: integer description: Offset used for this response required: - total - limit - offset ApiError: type: object properties: code: type: string description: Machine-readable error code example: NOT_FOUND message: type: string description: Human-readable error description required: - code - message ClientId: type: string pattern: ^ovcid-.*$ ClientEmail: type: object properties: id: type: string format: uuid value: type: string format: email label: type: string isPrimary: type: boolean required: - id - value additionalProperties: false ClientPhoneNumber: type: object properties: id: type: string format: uuid value: type: string ext: type: number label: type: string isPrimary: type: boolean required: - id - value additionalProperties: false securitySchemes: OpenApiKeyAuth: type: apiKey in: header name: x-api-key description: Send the API key in the x-api-key header. ````