--- title: Gets all the organizations. slug: commerce-connect-15/service-api/gets-all-the-organizations docTags: createdAt: 2026-10-09T17:33:31.916Z --- { "id": "bKuyFEy3Ih80Ojd3tAt2h", "type": "api-oas-v2", "data": { "method": "GET", "url": "/episerverapi/commerce/customers/organization", "servers": [], "name": "Gets all the organizations.", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain", "application/json", "text/json" ], "default": "text/plain" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return the organizations.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Organization model.", "customType": "OrganizationModel[]", "schema": [ { "name": "primaryKeyId", "kind": "optional", "type": "string", "description": "

Organization ID (GUID).

", "format": "uuid" }, { "name": "addresses", "kind": "optional", "type": "array", "nullable": true, "description": "List of addresses.", "modelRef": "#/components/schemas/AddressModel", "customType": "AddressModel[]", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "

Address ID (GUID).

", "format": "uuid" }, { "name": "modified", "kind": "optional", "type": "string", "nullable": true, "description": "Last modified date.", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Address name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Country name." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Country code." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Postal code (Zip code).

" }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 2." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Region name." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Region code." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "isShippingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a shipping address or not." }, { "name": "isBillingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a billing address or not." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Evening phone number." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Organization name." }, { "name": "addressType", "kind": "optional", "type": "array", "nullable": true, "description": "Address type.", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "childOrganizations", "kind": "optional", "type": "array", "nullable": true, "description": "List of child organizations.", "modelRef": "#/components/schemas/OrganizationModel", "customType": "OrganizationModel[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "contacts", "kind": "optional", "type": "array", "nullable": true, "description": "List of contacts.", "modelRef": "#/components/schemas/ContactModel", "customType": "ContactModel[]", "schema": [ { "name": "primaryKeyId", "kind": "optional", "type": "string", "nullable": true, "description": "

Contact ID (GUID).

", "format": "uuid" }, { "name": "addresses", "kind": "optional", "type": "array", "nullable": true, "description": "Contacts addresses.", "modelRef": "#/components/schemas/AddressModel", "customType": "AddressModel[]", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "

Address ID (GUID).

", "format": "uuid" }, { "name": "modified", "kind": "optional", "type": "string", "nullable": true, "description": "Last modified date.", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Address name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Country name." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Country code." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Postal code (Zip code).

" }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 2." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Region name." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Region code." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "isShippingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a shipping address or not." }, { "name": "isBillingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a billing address or not." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Evening phone number." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Organization name." }, { "name": "addressType", "kind": "optional", "type": "array", "nullable": true, "description": "Address type.", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "registrationSource", "kind": "optional", "type": "string", "nullable": true, "description": "Registration source." } ] }, { "name": "organizationType", "kind": "optional", "type": "string", "nullable": true, "description": "Organization type." }, { "name": "orgCustomerGroup", "kind": "optional", "type": "string", "nullable": true, "description": "Organization customer group." }, { "name": "businessCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Business category." }, { "name": "name", "kind": "required", "type": "string", "description": "Organization name." }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "Organization description." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ], "modelRef": "#/components/schemas/OrganizationModel", "isExpanded": true } ] }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "be12Bcn6mo_iE4cAAvADf", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url /episerverapi/commerce/customers/organization \\\n --header 'accept: text/plain'" }, { "id": "edIKBqh6h9n0flDgMD1Y8", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/customers/organization\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "mLhz3EJmDiHdfR4cL5n3P", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/customers/organization\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "iilVwF7oyZd4B1-ziYIH9", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/customers/organization\"\n\npayload = {}\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "be12Bcn6mo_iE4cAAvADf" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return the organizations.\n[\n {\n \"primaryKeyId\": \"\",\n \"addresses\": [\n {\n \"addressId\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryName\": \"\",\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"regionName\": \"\",\n \"regionCode\": \"\",\n \"email\": \"\",\n \"isShippingAddress\": false,\n \"isBillingAddress\": false,\n \"daytimePhoneNumber\": \"\",\n \"eveningPhoneNumber\": \"\",\n \"organization\": \"\",\n \"addressType\": [\n 0\n ]\n }\n ],\n \"childOrganizations\": [\n {\n \"\": \"\"\n }\n ],\n \"contacts\": [\n {\n \"primaryKeyId\": \"\",\n \"addresses\": [\n {\n \"addressId\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryName\": \"\",\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"regionName\": \"\",\n \"regionCode\": \"\",\n \"email\": \"\",\n \"isShippingAddress\": false,\n \"isBillingAddress\": false,\n \"daytimePhoneNumber\": \"\",\n \"eveningPhoneNumber\": \"\",\n \"organization\": \"\",\n \"addressType\": [\n 0\n ]\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"registrationSource\": \"\"\n }\n ],\n \"organizationType\": \"\",\n \"orgCustomerGroup\": \"\",\n \"businessCategory\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "id": "response-1-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }