Get the team profile | Sample

2 parameters

tokenstringrequired

Authentication token with the `users.profile:read` scope.

visibilitystringoptional

Filter the returned profile fields by visibility.

2 status codes

200Returns an object with `ok` set to true and a `profile` object containing the team's `fields` array.

okbooleanrequired

Allowed:true

profileobjectrequired

defaultReturns an error object with `ok` set to false and an `error` value describing why the team profile could not be retrieved.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactiveno_permissionuser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typmissing_post_typeteam_added_to_org

okbooleanrequired

Allowed:false

Error handling

Supply token with the users.profile:read scope. If provided, visibility must identify the profile visibility filter you want to apply.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.teamProfileGet.list({
  token: "sk_live_4eC39Hq",
  visibility: "example",
});

{
  "ok": true,
  "profile": {
    "fields": [
      {
        "hint": "Enter the extension to reach your desk",
        "id": "Xf06054AAA",
        "is_hidden": 1,
        "label": "Phone extension",
        "options": null,
        "ordering": 0,
        "possible_values": null,
        "type": "text"
      },
      {
        "hint": "When you were born",
        "id": "Xf06054BBB",
        "label": "Date of birth",
        "options": null,
        "ordering": 1,
        "possible_values": null,
        "type": "date"
      },
      {
        "hint": "Enter a link to your Facebook profile",
        "id": "Xf06054CCC",
        "label": "Facebook",
        "options": null,
        "ordering": 2,
        "possible_values": null,
        "type": "link"
      },
      {
        "hint": "Hogwarts, obviously",
        "id": "Xf06054DDD",
        "label": "House",
        "options": null,
        "ordering": 3,
        "possible_values": [
          "Gryffindor",
          "Hufflepuff",
          "Ravenclaw",
          "Slytherin"
        ],
        "type": "options_list"
      },
      {
        "hint": "Office location (LDAP)",
        "id": "Xf06054EEE",
        "label": "Location",
        "options": {
          "is_protected": 1
        },
        "ordering": 4,
        "possible_values": null,
        "type": "text"
      },
      {
        "hint": "The boss",
        "id": "Xf06054FFF",
        "label": "Manager",
        "options": null,
        "ordering": 5,
        "possible_values": null,
        "type": "user"
      }
    ]
  }
}

Request

Response

Errors