Skip to content
OpenBot

channels.listChannelIdentities

GET
/v1/organization/channels/{channelId}/identities
curl --request GET \
  --url https://example.com/v1/organization/channels/example/identities \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
channelId
required
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
channel
required
string
>= 1 characters <= 128 characters
externalUserId
required
string
displayName
required
string
userId
required
string
createdAt
required
number

Example generated

[
  {
    "channel": "example",
    "externalUserId": "example",
    "displayName": "example",
    "userId": "example",
    "createdAt": 1
  }
]

400

Section titled “400”

ChannelInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChannelInvalid
message
required
string

Example 

{
  "_tag": "ChannelInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

ChannelNotFound | ChannelIdentityNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChannelNotFound
id
required
string

Example 

{
  "_tag": "ChannelNotFound"
}

409

Section titled “409”

ChannelConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: ChannelConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "ChannelConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | ChannelsUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}