TMF629 v4 Customer Management

GET Get Customers

GET /customer

Retrieves a list of Customer entities. Attribute selection is enabled for first-level attributes.

Parameters

fields (query, string) Specifies the comma-separated properties to be included in the response. supported fields are name, id.
offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
pageLimit (query, integer) Specifies the requested number of the resources to be included in the response.
id (query, string) Unique identifier for Customers
name (query, string) term by which the Customer is known and distinguished from other Customers
Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
Version (header, string, required) Specifies the version to use with the URL path. version should be greater than or equal to v58.0
Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.

Responses

200 successfully retrieved the customer list

Media type: application/json. Schema: array of customer_get.

Array of customer_get.

Example

[
  {
    "account": [
      {
        "description": "US, UK, Eastern Europe, Japan, and SE Asia.",
        "href": "/services/data/v60.0/sobjects/account/001xx000003GYdPAAE",
        "id": "001xx000003GYdPAAE",
        "name": "Grand Hotels",
        "referredType": "Billing Account"
      }
    ],
    "agreement": [
      {
          "href": "/services/data/v60.0/sobjects/contract/800xx000000bna5AAA",
          "id": "800xx000000bna5AAA",
          "name": "Contract Of Legal Issue"
      }
    ],
    "engagedParty": 
    {
        "href": "/services/data/v60.0/sobjects/contact/003xx000004WhECAA0",
        "id": "003xx000004WhECAA0",
        "name": "Rose Gonzalez",
        "role": "Individual"
    },
    "href": "/connect/comms/openapi/customermanagement/customer/001xx000003GYdLAAX",
    "id": "001xx000003GYdLAAX",
    "name": "Pyramid Construction Inc."
  },
  {
    "account": [
      {
        "description": "Chain of hotels and resorts across the US, UK, Eastern Europe, Japan, and SE Asia.",
        "href": "/services/data/v60.0/sobjects/account/001xx000003GYdPAAW",
        "id": "001xx000003GYdPAAW",
        "name": "Grand Hotels &amp; Resorts Ltd",
        "referredType": "Billing Account"
      }
    ],
    "agreement": [
      {
        "href": "/services/data/v60.0/sobjects/contract/800xx000000bna5AAA",
        "id": "800xx000000bna5AAA",
        "name": "Contract Of Legal Issue"
      }
    ],
    "engagedParty": 
    {
        "href": "/services/data/v60.0/sobjects/contact/003xx000004WhECAA0",
        "id": "003xx000004WhECAA0",
        "name": "Rose Gonzalez",
        "role": "Individual"
    },
    "href": "/connect/comms/openapi/customermanagement/customer/001xx000003GYdLAAW",
    "id": "001xx000003GYdLAAW",
    "name": "Edge Communications"
  }
]

404 Resource not found.

Media type: application/json. Schema: Error.

Example

code: RECORD_NOT_FOUND
reason: The specified Customer ID doesn’t exist. Provide a valid Customer ID and try again.