teamProfileGet
Retrieve a team’s profile.
Details
- Method:
GET - Path:
/team.profile.get - Operation ID:
team_profile_get
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `users.profile:read`",
"required": true,
"location": "query",
"type": "string"
},
"visibility": {
"description": "Filter by visibility.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response from team.profile.get method",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"profile": {
"additionalProperties": false,
"properties": {
"fields": {
"items": {
"additionalProperties": false,
"properties": {
"field_name": {
"type": [
"null",
"string"
]
},
"hint": {
"type": "string"
},
"id": {
"pattern": "^X[a-zA-Z0-9]{9,}$",
"type": "string"
},
"is_hidden": {
"type": "boolean"
},
"label": {
"type": "string"
},
"options": {
"items": [
{
"type": "null"
},
{
"additionalProperties": false,
"properties": {
"is_custom": {
"type": [
"null",
"boolean"
]
},
"is_multiple_entry": {
"type": [
"null",
"boolean"
]
},
"is_protected": {
"type": [
"null",
"boolean"
]
},
"is_scim": {
"type": [
"null",
"boolean"
]
}
},
"type": "object"
}
]
},
"ordering": {
"type": "number"
},
"possible_values": {
"items": {
"type": "string"
},
"type": [
"null",
"array"
]
},
"type": {
"enum": [
"text",
"date",
"link",
"mailto",
"options_list",
"user"
],
"type": "string"
}
},
"required": [
"id",
"ordering",
"label",
"hint",
"type"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"fields"
],
"type": "object"
}
},
"required": [
"ok",
"profile"
],
"title": "team.profile.get success schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('teamProfileGet', {
# Add required parameters here
})