--- title: List all customers slug: amberflo-api/list-all-customers docTags: createdAt: 2024-11-07T15:10:16.978Z --- { "id": "i_OIS3SSrlCMNOoYNOm6A", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/customers", "servers": [ { "url": "https://app.amberflo.io/customers" } ], "name": "List all customers", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "metadata.customer.CustomerDetails.out[]", "schema": [ { "name": "createTime", "kind": "optional", "type": "integer", "description": "Creation time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds)", "example": 0 }, { "name": "updateTime", "kind": "optional", "type": "integer", "description": "Update time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds)", "example": 0 }, { "name": "deleteTime", "kind": "optional", "type": "integer", "example": 0 }, { "name": "customerId", "kind": "required", "type": "string", "description": "Id of the customer, as it exists in your system.", "example": "" }, { "name": "customerName", "kind": "required", "type": "string", "description": "Name of the customer, as it exists in your system.", "example": "" }, { "name": "customerEmail", "kind": "optional", "type": "string", "description": "Email of the customer, as it exists in your system.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the customer.", "example": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "deprecated": true, "description": "Determines whether the customer is active or not. Setting it to false deactivates the customer. Only relevant when updating a customer.\n\nNote that this field is superseded by the `lifecycleStage` one, which allows finer grained control. When `enabled = false` means `lifecycleStage = OFFBOARDED`, other lifecycle stages mean `enabled = true` and vice-versa.", "example": "" }, { "name": "test", "kind": "optional", "type": "boolean", "description": "Determines whether the customer is a test customer. Can only be set once during creation. Test customers can be excluded from certain operations.\n\nDefaults to `false`.", "example": "" }, { "name": "lifecycleStage", "kind": "optional", "type": "string", "description": "The lifecycle stage of a customer. The lifecycle stage of a customer determines which features of the system are enabled for it.\n\nValid lifecycle stages are:\n- `ONBOARDING` - Only usage is tracked.\n- `TRAIL` - Both usage and billing data are tracked but customer will not be charged.\n- `ACTIVE` - Both usage and billing data are tracked and customer will be charged.\n- `OFFBOARDED` - Only usage is tracked.\n\nDefault: `ACTIVE`", "modelRef": "#/components/schemas/metadata.customer.CustomerLifecycleStage.out", "customType": "metadata.customer.CustomerLifecycleStage.out", "schema": [] }, { "name": "deactivateTimeStamp", "kind": "optional", "type": "integer", "example": 0 }, { "name": "traits", "kind": "optional", "type": "map", "description": "Reference metadata to integrate with external systems like billing.\n\nThe following traits are used by Amberflo:\n- `stripeId` for [integrating with Stripe](doc:stripe);\n- `awsm.customerIdentifier` for [integrating with AWS Marketplace](doc:associating-customers-with-aws-marketplace);\n- `currency` for the customer's currency, following the ISO standard.\n", "example": "", "customType": "map", "schema": [] }, { "name": "address", "kind": "optional", "type": "object", "description": "Tax address of the customer.", "modelRef": "#/components/schemas/metadata.customer.CustomerAddress.out", "customType": "metadata.customer.CustomerAddress.out", "schema": [ { "name": "verified", "kind": "optional", "type": "boolean", "example": "" }, { "name": "line1", "kind": "required", "type": "string", "example": "" }, { "name": "state", "kind": "optional", "type": "string", "example": "" }, { "name": "city", "kind": "required", "type": "string", "example": "" }, { "name": "postalCode", "kind": "optional", "type": "string", "example": "" }, { "name": "country", "kind": "required", "type": "string", "example": "" } ] } ], "modelRef": "#/components/schemas/metadata.customer.CustomerDetails.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "QlAxf3qwWd0JYXrdMgVsf", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/customers \\\n --header 'accept: application/json'" }, { "id": "p0M33Fdx1N8xhfcPbeM27", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/customers\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kVQJJU5fXrpVPVzGw32KP", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/customers\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "O5zycLqJLIs5CarnXTrCF", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/customers\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "QlAxf3qwWd0JYXrdMgVsf" }, "results": { "languages": [ { "id": "CJL-Sc8-NkiMNEkSMQoZN", "language": "200", "code": "// Successful request\n[\n {\n \"createTime\": \"\",\n \"updateTime\": \"\",\n \"deleteTime\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"customerEmail\": \"\",\n \"description\": \"\",\n \"enabled\": false,\n \"test\": false,\n \"lifecycleStage\": \"\",\n \"deactivateTimeStamp\": \"\",\n \"traits\": \"\",\n \"address\": {\n \"verified\": false,\n \"line1\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n }\n }\n]" } ], "selectedLanguageId": "CJL-Sc8-NkiMNEkSMQoZN" } }, "children": [ { "text": "" } ] }