Search Organization End Users

GET /v1/end-users/organizations — Search and filter organization end users with pagination. Requires end-users:read scope.

Returns a paginated list of organization end users matching your filter criteria. All query parameters are optional — omitting them returns all organization end users accessible to your account in descending creation order. You can narrow results by name (partial match), specific end user IDs, product, or your own internal identifier. Use page and limit to walk through large result sets.

​

Endpoint

GET /v1/end-users/organizations

Required scope: com.diameterpay.api/end-users.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth 2.0 token endpoint. Format: Bearer {access_token}

​

Query Parameters

page · integer

Page number to return. Defaults to 1.

limit · integer

Number of records per page. Defaults to 10. Maximum is 100.

name · string

Partial name search applied against fullName. Case-insensitive. For example, name=acme matches Acme Technologies Inc. and Acme Holdings LLC.

endUserIds · array

Filter to a specific set of organization UUIDs. Pass multiple values as repeated query parameters: endUserIds=uuid1&endUserIds=uuid2.

productId · string

UUID v4 of the product. When provided, only organizations associated with that product are returned.

internalEndUserId · string

Exact match filter on internalEndUserIdentifier. Useful for looking up a Diameter record using your own system’s ID.

​

Response

Returns 200 OK with a paginated response envelope containing an array of organization end user objects.

data · array

Array of organization end user objects matching the query. Each object has the same structure as the Get Organization End User response.

pagination · object

Pagination metadata.

Show pagination fields

page · integer

The current page number.

limit · integer

Number of records returned per page.

totalItems · integer

Total number of organization end users matching the filter criteria.

totalPages · integer

Total number of pages available given the current limit.

hasNextPage · boolean

true if there is at least one more page of results after this one.

hasPreviousPage · boolean

true if this is not the first page.

​

Example Request

curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/organizations?page=1&limit=10&name=acme&productId=a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Authorization: Bearer {access_token}'

​

Filtering by Multiple IDs

curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/organizations?endUserIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&endUserIds=b2c3d4e5-f6a7-8901-bcde-f01234567890' \
  --header 'Authorization: Bearer {access_token}'

​

Lookup by Internal ID

curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/organizations?internalEndUserId=org_9876543210' \
  --header 'Authorization: Bearer {access_token}'

​

Example Response

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fullName": "Acme Technologies Inc.",
      "doingBusinessAs": "Acme Tech",
      "businessIndustry": "Computer Systems Design (NAICS 541512)",
      "businessEntityType": "CORPORATION",
      "formationDate": "2010-03-22",
      "incorporationCountry": "US",
      "incorporationState": "DE",
      "idType": "EIN",
      "idNumber": "12-3456789",
      "email": "[e-mail]",
      "mobilePhone": "[phone]",
      "pepStatus": "NO",
      "website": "https://acmetech.com",
      "onboardingStatus": "ACTIVE",
      "onboardedInBanks": ["PORTAGE"],
      "addresses": [
        {
          "addressType": "BUSINESS",
          "country": "US",
          "postalCode": "19801",
          "townName": "Wilmington",
          "streetName": "Market Street",
          "buildingNumber": "100",
          "countrySubdivision": "DE"
        }
      ],
      "internalEndUserIdentifier": null,
      "createdAt": "2024-06-01T14:30:00.000Z",
      "updatedAt": "2024-06-01T14:35:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}