AT&T DevEx

Auto Ingest Testing Product

Get Organization

Version 1.0.0
download iconDownload spec

Endpoint

GET
undefined/organization

Search for an organization by organization Name and Address. An organization is considered a match when we are able to find a record with the given organization name and the given Address for a particular organization. Returns a list to be TMF compliant, but will be one or none

arrowSecurity

http

scheme:bearer
arrowRequest

Query Parameters

                Body Parameters

                Responses

                Successful Response

                arrowBody

                application/json
                  • [
                    {
                    • }
                    ]

                REQUEST

                1
2
3
                curl --request GET \
     --url 'https://example.com/organization?country=US&name=Bridgeport%20Benefits%20of%20Hawaii%2C%20LLC&street1=700%20Bishop%20St%20Ste%20502&street2=Suite%2020&city=Honolulu&state=HI&postCode=96813' \
     --header 'accept: application/json'

                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
                [
  {
    "id": "a8216bbf-fb08-48cd-982f-e238d3ecb828",
    "href": "https://cims-westus2-poc-cims-container-as.azurewebsites.net/organization/a8216bbf-fb08-48cd-982f-e238d3ecb828",
    "name": "Florida Department of Labor and Employment Security",
    "@type": "string",
    "status": "initiated",
    "otherName": [
      {
        "name": "string",
        "@type": "string",
        "validFor": {
          "endDateTime": "2026-01-26T09:01:49.265Z",
          "startDateTime": "2026-01-26T09:01:49.265Z"
        },
        "tradingName": "string"
      }
    ],
    "tradingName": "Bureau of Compliance",
    "isHeadOffice": false,
    "existsDuring": {
      "endDateTime": "2026-01-26T09:01:49.265Z",
      "startDateTime": "2026-01-26T09:01:49.265Z"
    },
    "relatedParty": [
      {
        "id": "0daf2215-f76f-48ff-8959-a440c0d3bd2b",
        "href": "https://cims-westus2-poc-cims-container-as.azurewebsites.net/organization/0daf2215-f76f-48ff-8959-a440c0d3bd2b",
        "name": "string",
        "role": "string",
        "@type": "string",
        "@referredType": "string"
      }
    ],
    "contactMedium": [
      {
        "@type": "string",
        "validFor": {
          "endDateTime": "2026-01-26T09:01:49.265Z",
          "startDateTime": "2026-01-26T09:01:49.265Z"
        },
        "preferred": false,
        "mediumType": "Postal Address",
        "characteristic": {
          "city": "Miami",
          "@type": "string",
          "country": "US",
          "street1": "492 KOLLER STREET",
          "street2": "string",
          "postCode": "94110",
          "faxNumber": "string",
          "contactType": "Telephone Number",
          "phoneNumber": "14135273445",
          "emailAddress": "florida_labor@gmail.com",
          "stateOrProvince": "FL"
        }
      }
    ],
    "organizationIdentification": [
      {
        "@type": "string",
        "identificationId": "001000905",
        "identificationType": "D&B"
      }
    ],
    "organizationChildRelationship": [
      {
        "@type": "string",
        "organization": {
          "id": "348882b5-4072-4f5f-a931-7134252b266b",
          "href": "https://cims-westus2-poc-cims-container-as.azurewebsites.net/organization/348882b5-4072-4f5f-a931-7134252b266b",
          "name": "string",
          "@type": "string",
          "@referredType": "string"
        },
        "relationshipType": "string"
      }
    ],
    "organizationParentRelationship": {
      "@type": "string",
      "organization": {
        "id": "348882b5-4072-4f5f-a931-7134252b266b",
        "href": "https://cims-westus2-poc-cims-container-as.azurewebsites.net/organization/348882b5-4072-4f5f-a931-7134252b266b",
        "name": "string",
        "@type": "string",
        "@referredType": "string"
      },
      "relationshipType": "string"
    }
  }
]