Skip to main content
GET
/
v2.0
/
projects
/
{projectId}
/
members
/
{userId}
Reads a project member.
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/projects/{projectId}/members/{userId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "roles": [
    "agentAssistConfigAdmin"
  ],
  "acceptedTOS": true,
  "disabled": true,
  "acl": {},
  "allowedLocales": [
    {
      "localeId": "<string>"
    }
  ],
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
projectId
string
required
Required string length: 24
​
userId
string
required

The Id of the User

Required string length: 24

Response

Returns the project member with all information.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
id
string
​
name
string
​
roles
enum<string>[]
Available options:
agentAssistConfigAdmin,
agentAssistConfigViewer,
analytics,
basic,
connection_admin,
contact_profile_admin,
contact_profile_editor,
contact_profile_viewer,
conversationHistory,
developer,
endpoint_admin,
extension_admin,
extension_editor,
flowEditor,
flowNodeComments,
flowNodeDescriptions,
followUser,
handoverProviderAdmin,
intents,
data_privacy_admin,
data_privacy_editor,
data_privacy_viewer,
knowledgeAdmin,
large_language_model_admin,,
lexicon_admin,
lexicon_editor,
localesAdmin,
logs,
memberManager,
nlu_connector_admin,
packages_admin,
playbook_admin,
playbook_editor,
projectAdmin,
snapshot_admin,
tokenAdmin,
tokenEditor,
function_admin,
function_editor,
simulator_admin,
admin
​
acceptedTOS
boolean
​
disabled
boolean
​
acl
object
​
allowedLocales
object[] | null
​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24