Skip to main content

team.profile.get method

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Usage info​

This method is used to get the profile field definitions for this team.

The team_id is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token. The optional visibility argument allows the client to filter the profile fields based on visibility. The following values are supported:

  • all is the default, and returns all fields.
  • visible returns only fields for which the is_hidden option is missing or false.
  • hidden returns only fields for which the is_hidden option is true.

Response​

The response contains a profile item with an array of key value pairs. Right now only the fields key is supported, which contains a list of field definitions for this team.

There are two ways to update a field. The value of is_scim determines which method to use:

  • If is_scim is True, update the field via a SCIM API call
  • If is_scim is False, update the field via users.profile.set. You'll need its id to do so. Field | Type | Description --------------|--------------|------------ id | String | The ID of either the section or field is_protected | Boolean | is_scim | Boolean | If true, can be updated via SCIM APIs field_name| String | The name of the field hint | String | Any additional context the user may need to understand the field label | String | The text that will appear under the field or section possible_values | String | The values that allowed to be chosen by the user options | String| An object containing the is_protected and is_scim fields ordering | Integer | The placement of the field or section on the profile section_id| String | The id of the section the field is in section_type | String | The type of content in the section. Users can only create custom section types type | String | The format the field supports. Can be date, link, long_text, options_list, tags, text, or user