# List your services > List your services: TrueProxies customer API reference with the required scope, parameters, responses and code samples. Source: https://docs.trueproxies.com/api/operations/get_v1_services/ `GET /v1/services` **Fetch** ```js const url = 'https://api.trueproxies.com/v1/services?limit=25&view=current'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **cURL** ```sh curl --request GET \ --url 'https://api.trueproxies.com/v1/services?limit=25&view=current' \ --header 'Authorization: Bearer ' ``` Current services by default. Use view=history for closed services or view=all for all records. Supports cursor pagination; each view has its own total. ## Authorizations - **[customerAPIKey](https://docs.trueproxies.com/api/#customerapikey)** ## Parameters ### Query Parameters - **customer\_id** string format: uuid Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes. - **cursor** string - **limit** integer default: 25 >= 1 <= 100 - **view** string default: current Allowed values: current history all Current includes every service that is not permanently closed, including activation failures and services needing renewal or support. History contains effectively closed services. All returns both groups for account-wide summaries and eligibility checks. ## Responses ### 200 Ok Media type: `application/json` object - **items** required Array\ object - **billing\_read\_only** required Existing access remains available, but this service cannot be topped up or renewed. New plan purchases are separate. boolean - **capabilities** required Array\ - **city** string - **comparison\_pass** Free private comparison with fixed speed and expiry; cannot be purchased, topped up or renewed. boolean - **connects\_per\_second** required Effective limit for this service. integer - **created\_at** required string format: date-time - **depleted** boolean - **display\_name** required Unlimited service names reflect their actual speed and term; offer\_key retains the original billing plan. string - **expires\_at** string format: date-time - **grace\_until** string format: date-time - **host** required string - **id** required Internal API identifier. Use reference for customer-facing display. string format: uuid - **max\_connections** required Effective limit for this service. integer - **offer\_key** required string - **ports** required object - **http** required integer - **https** required integer - **socks5** required integer - **product** required string Allowed values: residential\_ipv4\_gb residential\_ipv4\_unlimited datacenter\_ipv6 trial - **reference** required Stable, unique customer-facing reference. string /^SVC-\[0-9]{6,}$/ - **renewals\_enabled** required boolean - **speed\_bps** 0 for paid residential\_ipv4\_gb means no additional TrueProxies speed cap. Private comparison passes have a fixed 50000000 bps cap. residential\_ipv4\_unlimited retains its positive plan speed. Upstream capacity and availability still apply. Trials and datacenter plans retain their speed limits. integer format: int64 - **starts\_at** string format: date-time - **status** required string Allowed values: pending active expired closed suspended failed - **term** string Allowed values: hour day week month - **term\_label** Actual fixed duration for a free Unlimited grant, such as 3 hours. Overrides the recurring term label in customer views. string - **trial\_started\_at** First recorded trial traffic; absent until the first request starts the 30-minute window. string format: date-time - **usage\_source** required string Allowed values: node - **username\_base** required string - **whitelist\_entries** integer - **limit** required integer - **next\_cursor** string - **total** required integer ##### Example ```json { "items": [ { "product": "residential_ipv4_gb", "reference": "SVC-001001", "status": "pending", "term": "hour", "usage_source": "node" } ] } ``` ### 400 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 401 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 403 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 404 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 409 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 429 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 500 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ``` ### 503 Error Media type: `application/json` object - **code** required string Allowed values: BAD\_REQUEST UNAUTHENTICATED FORBIDDEN NOT\_FOUND CONFLICT RATE\_LIMITED SERVICE\_UNAVAILABLE OFFER\_UNAVAILABLE CITY\_UNAVAILABLE CAPACITY\_UNAVAILABLE INVOICE\_NOT\_PAYABLE PROVIDER\_ERROR PIPE\_UNAVAILABLE TRIAL\_NOT\_ELIGIBLE EMAIL\_UNVERIFIED INTERNAL - **details** What a client needs to act on the error (ids, flags), never display text. object - ***key*** additional properties any - **message** required string ##### Example ```json { "code": "BAD_REQUEST" } ```