Custom

GET Get a list of resolved Custom API endpoints.

GET /organizations/{organizationId}/endpoints

Operation ID: getEndpoints. Security: AmOAuth2 (sfcc.custom-apis).

List resolved Custom API endpoints, including not registered endpoints.

Parameters

• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• status (query, EndpointStatus) Filter endpoints by registration status.

Responses

• 200 Successful operation

  Media type: application/json. Schema: CustomApiEndpointResult.

  Example: SuccessWithFilter

  {
    "limit": 1,
    "total": 2,
    "filter": {
      "status": "active"
    },
    "data": [
      {
        "apiName": "loyalty-info",
        "apiVersion": "v1",
        "cartridgeName": "my_cartridge",
        "endpointPath": "/customers",
        "status": "active"
      }
    ],
    "activeCodeVersion": "version1"
  }

  Example: SuccessWithoutFilter

  {
    "limit": 2,
    "total": 2,
    "data": [
      {
        "apiName": "loyalty-info",
        "apiVersion": "v1",
        "cartridgeName": "my_cartridge",
        "endpointPath": "/customers",
        "status": "active"
      },
      {
        "apiName": "loyalty-info",
        "apiVersion": "v1",
        "cartridgeName": "null",
        "endpointPath": "/customers",
        "errorReason": "Cartridge 'my_cartridge_2' not found.",
        "status": "not_registered"
      }
    ],
    "activeCodeVersion": "version1"
  }

• 400 Invalid or malformed filter parameter

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: InvalidFilterParameter

  {
    "title": "Bad Request",
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
    "detail": "Invalid value 'foo' for filter parameter 'status'."
  }