Skip to main content
GET/application/

Application info

Returns your workspace (application) and its team members.

Each team member comes with an id, name, email and status. You need a team member's id when you create records on their behalf, for example a message sent as an agent.

Request​

curl -X GET "https://<your_app_subdomain>.user.com/api/public/application/" \
-H "Authorization: Token <your_64_char_api_key>" \
-H "Accept: */*; version=2"

Response examples​

{
"id": 1,
"key": "ab12cd",
"title": "My workspace",
"agents": [
{
"id": 2,
"name": "Jane Agent",
"email": "agent@example.com",
"status": "agent",
"group_id": 2
}
]
}

Response fields​

Fields returned in the 200 OK response body.

idinteger
ID of the workspace.
keystring
The workspace key: 6 lowercase letters and digits. It is the apiKey of the JavaScript SDK.
titlestring
Name of the workspace.
agentsarray of objects
Team members of the workspace. The list also includes removed team members and pending invitations.
agents[].idinteger
ID of the team member.
agents[].namestring
Name of the team member.
agents[].emailstring
Email address of the team member.
agents[].statusstring
Role of the team member. Currently always agent, the workspace owner included.
agents[].group_idinteger
ID of the team member's own automatic group (every team member has one). It is not a team member group created in Settings. Not returned for removed team members.
note

Errors that can come from any endpoint (401, 429, 500, 502, 504) are described in HTTP response codes.