List all customers

Retrieves a list of all OEM customers in your partner account with summary information.

Filtering:

  • Use the optional appId query parameter to filter customers who have keysets in a specific application
  • Without filtering, returns all customers across all applications
Query Parameters
appId string

Optional application ID to filter customers by application

Optional application ID to filter customers by application

Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2026-02-09]

Responses
200

Success

Schema — OPTIONAL
result object[]
id string
externalId string
name string
created string

a string to be decoded into a Date

updated string

a string to be decoded into a Date

appCount number
keysetCount number
400

Bad Request Error

Schema — OPTIONAL
statusCode number
error string

Possible values: [BadRequest]

message string[]
401

UnauthorizedError

Schema — OPTIONAL
statusCode number
error string

Possible values: [Unauthorized]

message string[]
403

ForbiddenError

Schema — OPTIONAL
statusCode number
error string

Possible values: [Forbidden]

message string[]
500

InternalErrorError

Schema — OPTIONAL
statusCode number
error string

Possible values: [InternalError]

message string[]
* required
PubNub-Version*
Type: string
Possible values: [2026-02-09]
appId
Type: string
Optional application ID to filter customers by application
result
Type: array
Array items:
items
Type: object
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"BadRequest"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"Unauthorized"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"Forbidden"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"InternalError"
message
Type: array
Array items:
items
Type: string