> ## Documentation Index > Fetch the complete documentation index at: https://anyip.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieves the collection of ProxyAccount resources. > Retrieves the collection of ProxyAccount resources. ## OpenAPI ````yaml /openapi.json get /api/proxy_accounts openapi: 3.1.0 info: title: AnyIP.io API documentation description: >- The anyIP REST API allows you to programmatically manage proxy accounts, monitor traffic, and access geographic data. Authenticate using your API key. version: 1.0.0 servers: - url: https://dashboard.anyip.io description: anyIP Production API security: - apiHeader: [] tags: [] paths: /api/proxy_accounts: get: tags: - ProxyAccount summary: Retrieves the collection of ProxyAccount resources. description: Retrieves the collection of ProxyAccount resources. operationId: api_proxy_accounts_get_collection parameters: - name: page in: query description: The collection page number required: false deprecated: false schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: The number of items per page required: false deprecated: false schema: type: integer default: 30 minimum: 0 style: form explode: false allowReserved: false - name: username in: query description: '' required: false deprecated: false schema: type: string style: form explode: false allowReserved: false - name: description in: query description: '' required: false deprecated: false schema: type: string style: form explode: false allowReserved: false responses: '200': description: ProxyAccount collection content: application/ld+json: schema: type: object properties: hydra:member: type: array items: $ref: '#/components/schemas/ProxyAccount.jsonld-read' hydra:totalItems: type: integer minimum: 0 hydra:view: type: object properties: '@id': type: string format: iri-reference '@type': type: string hydra:first: type: string format: iri-reference hydra:last: type: string format: iri-reference hydra:previous: type: string format: iri-reference hydra:next: type: string format: iri-reference example: '@id': string type: string hydra:first: string hydra:last: string hydra:previous: string hydra:next: string hydra:search: type: object properties: '@type': type: string hydra:template: type: string hydra:variableRepresentation: type: string hydra:mapping: type: array items: type: object properties: '@type': type: string variable: type: string property: type: - string - 'null' required: type: boolean required: - hydra:member application/json: schema: type: array items: $ref: '#/components/schemas/ProxyAccount-read' text/html: schema: type: array items: $ref: '#/components/schemas/ProxyAccount-read' '403': description: Forbidden deprecated: false components: schemas: ProxyAccount.jsonld-read: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: - http://www.w3.org/ns/hydra/core# required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string description: maxLength: 256 type: - string - 'null' enabled_by_admin: default: true example: true type: boolean status: readOnly: true default: ACCOUNT_BLOCKED example: ACCOUNT_BLOCKED type: string is_active: readOnly: true type: boolean enabled: default: true example: true type: boolean id: readOnly: true type: string ip_whitelist: $ref: '#/components/schemas/IPWhitelist.jsonld-read' plain_password: minLength: 6 type: - string - 'null' quota: type: integer username: minLength: 6 type: string hash: readOnly: true type: string quota_str: readOnly: true type: string bytes_recv: type: integer bytes_sent: type: integer consumption: readOnly: true type: integer consumption_str: readOnly: true type: string ProxyAccount-read: type: object description: '' deprecated: false properties: description: maxLength: 256 type: - string - 'null' enabled_by_admin: default: true example: true type: boolean status: readOnly: true default: ACCOUNT_BLOCKED example: ACCOUNT_BLOCKED type: string is_active: readOnly: true type: boolean enabled: default: true example: true type: boolean id: readOnly: true type: string ip_whitelist: $ref: '#/components/schemas/IPWhitelist-read' plain_password: minLength: 6 type: - string - 'null' quota: type: integer username: minLength: 6 type: string hash: readOnly: true type: string quota_str: readOnly: true type: string bytes_recv: type: integer bytes_sent: type: integer consumption: readOnly: true type: integer consumption_str: readOnly: true type: string IPWhitelist.jsonld-read: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: - http://www.w3.org/ns/hydra/core# required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string ips: type: array items: type: string ports: type: array items: $ref: '#/components/schemas/Port.jsonld-read' is_enabled: type: boolean IPWhitelist-read: type: object description: '' deprecated: false properties: ips: type: array items: type: string ports: type: array items: $ref: '#/components/schemas/Port-read' is_enabled: type: boolean Port.jsonld-read: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: - http://www.w3.org/ns/hydra/core# required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string port: minimum: '2000' maximum: '2999' type: integer type: enum: - residential - mobile type: - string - 'null' country: minLength: 2 maxLength: 2 pattern: ^([A-Z]+)$ type: - string - 'null' city: minLength: 1 maxLength: 100 pattern: ^([a-z'-]+)$ type: - string - 'null' session: minLength: 3 maxLength: 32 type: - string - 'null' sess_time: minimum: 1 maximum: 60 type: - integer - 'null' sess_replace: type: - boolean - 'null' sess_ip_collision: enum: - strict - flexible type: - string - 'null' Port-read: type: object description: '' deprecated: false properties: port: minimum: '2000' maximum: '2999' type: integer type: enum: - residential - mobile type: - string - 'null' country: minLength: 2 maxLength: 2 pattern: ^([A-Z]+)$ type: - string - 'null' city: minLength: 1 maxLength: 100 pattern: ^([a-z'-]+)$ type: - string - 'null' session: minLength: 3 maxLength: 32 type: - string - 'null' sess_time: minimum: 1 maximum: 60 type: - integer - 'null' sess_replace: type: - boolean - 'null' sess_ip_collision: enum: - strict - flexible type: - string - 'null' securitySchemes: apiHeader: type: apiKey description: Value for the api-key header parameter. name: api-key in: header ````