AT&T DevEx

Omni APIs Central | Wireline Solutions | Partners | Service Existing Fiber | Change Order

Customer Search

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://partner.att.com/omni-svcs/v1/customers/search

Returns Customers associated individuals, and account information.

arrowRequest

Customer search request payload

Header Parameters

    Body Parameters

    Responses

    OK

    arrowBody

    application/json

    REQUEST

    1
2
3
4
5
6
7
8
9
10
11
    curl --request POST \
     --url https://partner.att.com/omni-svcs/v1/customers/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "serviceType": "FIBER",
  "pageSize": 5,
  "pageOffset": 1
}
'

    RESPONSE

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    {
  "totalCount": 1,
  "pageInfo": {
    "pageSize": 5,
    "pageOffset": 1
  },
  "individuals": [
    {
      "id": "7ad6d9b1-1f26-4b7f-a76f-013b1b2d55de",
      "givenName": "JANE",
      "familyName": "DOE",
      "preferredName": "JANIE",
      "profile": {
        "firstName": "JANE",
        "lastName": "DOE",
        "middleInitial": "A"
      },
      "status": "ACTIVE",
      "createdOn": "2025-01-10T09:00:00Z",
      "updatedOn": "2026-02-15T11:25:00Z",
      "accounts": [
        {
          "id": "123456789",
          "givenName": "JANE",
          "familyName": "DOE",
          "title": "Ms",
          "middleInitial": "A",
          "accountType": "Consumer",
          "accountSubType": "Consumer Small Office",
          "ratingType": "STANDARD",
          "serviceType": "FIBER",
          "targetSOR": "LS-CRM-DB",
          "subscribersCount": "1",
          "createdOn": "2024-06-01T12:00:00Z",
          "lastModified": "2026-02-20T08:30:00Z",
          "openDate": "2024-06-02T00:00:00Z",
          "billingMarket": "DAL",
          "billingSubMarket": "DAL-NORTH",
          "accountLocked": "N",
          "state": {
            "state": "ACTIVE"
          },
          "isDigitalAccount": true,
          "languagePreference": "en",
          "smbContactInfo": {
            "nameInfo": {
              "firstName": "JANE",
              "lastName": "DOE"
            }
          },
          "subscribers": [
            {
              "id": "SUB-10001",
              "phoneNumber": "**********",
              "createdOn": "2024-06-02T00:00:00Z",
              "updatedOn": "2026-02-19T10:10:00Z",
              "activationDate": "2024-06-02T00:00:00Z",
              "effectiveDate": "2026-02-19T10:10:00Z",
              "subMarket": "DAL-NORTH",
              "status": {
                "state": "ACTIVE"
              },
              "products": [
                {
                  "productOfferingTypeGroup": "BBOffer",
                  "isBundle": false,
                  "productOfferingClassification": "FIBER_PLAN",
                  "name": "AT&T Internet 1000",
                  "description": "1 GIG speed + unlimited internet data",
                  "status": {
                    "status": "ACTIVE"
                  },
                  "activationDate": "2024-06-02T00:00:00Z",
                  "creationDate": "2024-06-01T12:00:00Z",
                  "lastUpdate": "2026-02-19T10:10:00Z",
                  "place": [
                    {
                      "id": "ADDR-01"
                    }
                  ],
                  "productCharacteristic": [
                    {
                      "name": "downloadSpeed",
                      "value": "1000 Mbps"
                    },
                    {
                      "name": "usageAllowance",
                      "value": "Unlimited"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}