Version 1.0
Connector Overview: This page documents all 40 actions for the Hootsuiteconnector v1.0.
Authentication (2)
GET OAuth2 Authorize
/oauth2/auth
OAuth2 Authorize endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the media type the client expects in the response, such as "application/json". |
|
|
Set the media type of the request body, typically "application/x-www-form-urlencoded". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Indicate the desired authorization response type, for example "code". |
|
|
Provide the client identifier assigned to your application during registration. |
|
|
Request a space-separated list of permission scopes your application needs. |
|
|
Supply the URI to which the authorization server will redirect the user after consent. |
POST OAuth2 Token
/oauth2/token
OAuth2 Token endpoint. The required parameters depend on the grant type requested:
|
Required Parameter |
Grant Type |
|---|---|
|
code |
authorization_code |
|
redirect_uri |
authorization_code |
|
member_id |
member_app |
|
organization_id |
organization_app |
|
refresh_token |
refresh_token |
This endpoint requires that you pass in your client credentials using the HTTP Basic authentication scheme as per outlined in the spec.
Including your client credentials in the request-body is not supported.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type, typically "application/x-www-form-urlencoded". |
|
|
Include the client credentials encoded in Base64 for Basic authentication. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Indicate the grant type, either "authorization_code" or "refresh_token". |
|
|
Provide the authorization code received from the authorize endpoint when using authorization_code grant. |
|
|
Supply the same redirect URI used in the authorization request to validate the code. |
|
|
Pass the member identifier if required for token exchange in a multi-user context. |
|
|
Provide the organization identifier when the token is scoped to a specific organization. |
|
|
Optionally request a subset of scopes; if omitted, the token will include all originally granted scopes. |
|
|
Supply the refresh token to obtain a new access token when using the refresh_token grant. |
Interactions
GET Get Interactions
/v1/interactions/{socialNetworkType}
Retrieves the interactions between two users of a particular social network type such as direct messages, comments, and posts.
This API is only available to Enterprise users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the type of social network, such as "twitter" or "facebook", as part of the path. |
|
|
Filter interactions to those involving a specific social network ID. |
|
|
Filter interactions to those involving a specific target social network ID. |
|
|
Provide a cursor from a previous response to paginate through subsequent pages of interactions. |
|
|
Set the maximum number of interactions to return per page, up to a server-defined limit. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the query behavior. |
Me (3)
GET Retrieve authenticated member
/v1/me
Retrieves authenticated member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the query behavior. |
GET Retrieve authenticated member's organizations
/v1/me/organizations
Retrieves the organizations that the authenticated member is in.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the query behavior. |
GET Retrieve authenticated member's social profiles
/v1/me/socialProfiles
Retrieves the social media profiles that the authenticated user has BASIC_USAGE permissions on.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the query behavior. |
Media (2)
POST Create media upload url
/v1/media
Creates an Amazon S3 upload URL that can be used to transfer media to Hootsuite which ensures the media is available when a scheduled message is sent to the social network.
Hootsuite will generate thumbnails and key frames and return a unique media identifier that can be passed when creating a message.
Subsequent uploads to an upload URL will be accepted by Amazon but immediately deleted by Hootsuite and only the first valid media file uploaded will be used.
The MIME type and size provided in this call must match the MIME type and size of the media uploaded.
Hootsuite will remove uploaded media 90 days after using the media in a message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the upload URL generation. |
GET Retrieve media upload status
/v1/media/{mediaId}
Retrieves the status of a media upload to Hootsuite.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the unique identifier of the media file whose upload status you want to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the status retrieval. |
Members (3)
POST Create member
/v1/members
Creates a member in a Hootsuite organization. Requires organization manage members permission.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the member creation. |
GET Retrieve member
/v1/members/{memberId}
Retrieves a member
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve member's organizations
/v1/members/{memberId}/organizations
Retrieves the organizations that the member is in.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
Messages (7)
POST Approve message
/v1/messages/{messageId}/approve
Approve a message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the message to approve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
DELETE Delete message
/v1/messages/{messageId}
Deletes a message. A message is always associated with a single social profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the message to delete. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Get message review history
/v1/messages/{messageId}/history
Gets a message's prescreening review history.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the message whose review history to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
POST Reject message
/v1/messages/{messageId}/reject
Reject a message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the message to reject. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve message
/v1/messages/{messageId}
Retrieves a message. A message is always associated with a single social profile. Messages might be unavailable for a brief time during upload to social networks.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the message to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve outbound messages
/v1/messages
Outbound messages are messages that are scheduled or were previously sent. This endpoint returns outbound messages sorted by increasing scheduled send time. Messages pending approval, including those created by and/or actionable by the given user, will also be returned via this API.
Messages returned can be filtered by social profile or the current state of the message. If more than 50 results are returned a cursor will be automatically created to paginate the results.
Query Parameters must be URL encoded. For example:
?startTime=2020-01-01T00%3A00%3A00Z
&endTime=2020-01-15T17%3A55%3A01Z
&socialProfileIds=1234
&state=SCHEDULED
&limit=5
To specify multiple social profiles, use the following syntax:
?socialProfileIds=1234&socialProfileIds=5678
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The start of the time range for which to retrieve messages, in ISO 8601 format. |
|
|
The end of the time range for which to retrieve messages, in ISO 8601 format. |
|
|
The state of the messages to retrieve, such as "SCHEDULED" or "SENT". |
|
|
Comma-separated list of social profile identifiers to filter messages by. |
|
|
Set the maximum number of interactions to return per page, up to a server-defined limit. |
|
|
Provide a cursor from a previous response to paginate through subsequent pages of interactions. |
|
|
Whether to include messages that are unscheduled and pending review, as "true" or "false". |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
POST Schedule messages
/v1/messages
Schedules a message to send on one or more social profiles (except Pinterest). Returns an array of uniquely identifiable messages (one per social profile requested).
Scheduling a message to Pinterest can not be bundled with any other social profiles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
Organizations (7)
DELETE Remove member from organization
/v1/organizations/{organizationId}/members/{memberId}
Removes a member from an organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization from which to remove the member. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve org member's organization permissions
/v1/organizations/{organizationId}/members/{memberId}/permissions
Retrieves an organization member’s permissions for the organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve org member's teams
/v1/organizations/{organizationId}/members/{memberId}/teams
Retrieves the teams an organization member is in.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve org member’s social profile permissions
/v1/organizations/{organizationId}/members/{memberId}/socialProfiles/{socialProfileId}/permissions
Retrieves an organization member’s permissions for a social profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
The unique identifier of the social profile whose permissions are being retrieved. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve org member’s social profiles
/
Retrieve the list of social profiles associated with an organization member. Use this to get an overview of all connected social accounts for a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve organization members
/v1/organizations/{organizationId}/members
Retrieves the members in an organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve organization teams
/v1/organizations/{organizationId}/teams
Retrieves a list of teams for a given organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
Scim 2.0 (6)
POST Create User
/scim/v2/Users
Creates a Hootsuite user using the SCIM 2.0 protocol.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Get Resource Types
/scim/v2/ResourceTypes
Retrieves the configuration for all supported SCIM resource types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Get User
/scim/v2/Users/{memberId}
Retrieves a Hootsuite user using the SCIM 2.0 protocol.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Get Users
/scim/v2/Users
Retrieves Hootsuite users using the SCIM 2.0 protocol. Support equals filtering on username.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
A SCIM filter expression to narrow down the user list based on specific attributes. |
|
|
The maximum number of user records to return in a single response. |
|
|
The 1-based index of the first user record to retrieve in the result set. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
PATCH Modify User
/scim/v2/Users/{memberId}
Modify one or more attributes of a Hootsuite user. For a complete example request, see the SCIM specification.
Limitations:
-
Currently we only support patching root level attributes with the replace operator
-
You cannot make modifications to a user after the
activeattribute has been set to false
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
PUT Replace User
/scim/v2/Users/{memberId}
Updates a Hootsuite user using the SCIM 2.0 protocol. To see the JSON object attributes required by the PUT endpoint, call the /Schemas endpoint. For a complete example request, see the SCIM specification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
Social Profiles (3)
GET Retrieve social profile
/v1/socialProfiles/{socialProfileId}
Retrieve a social profile. Requires BASIC_USAGE permission on the social profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the social profile whose permissions are being retrieved. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve social profile's teams
/v1/socialProfiles/{socialProfileId}/teams
Retrieves a list of team IDs with access to a social profile. Requires BASIC_USAGE permission on the social profile or ORG_MANAGE_SOCIAL_PROFILE permission on the organization that owns the social profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the social profile whose permissions are being retrieved. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve social profiles
/v1/socialProfiles
Retrieves the social profiles that the authenticated user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
Teams (6)
POST Add member to team
/v1/organizations/{organizationId}/teams/{teamId}/members/{memberId}
Adds a member to a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
The identifier of the team that will receive the new member. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
POST Create team
/v1/organizations/{organizationId}/teams
Creates a team in an organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve org team’s social profiles
/v1/organizations/{organizationId}/teams/{teamId}/socialProfiles
Retrieves the organization's social profiles that an organization team can access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
The identifier of the team whose social profiles are being retrieved. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve team
/v1/teams/{teamId}
Retrieves a team with a given team ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The identifier of the team to retrieve. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve team member's permissions
/v1/organizations/{organizationId}/teams/{teamId}/members/{memberId}/permissions
Retrieves team member's team permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
Provide the unique identifier of the member to retrieve. |
|
|
The identifier of the team that contains the member whose permissions are being retrieved. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |
GET Retrieve team members
/v1/organizations/{organizationId}/teams/{teamId}/members
Retrieves the members in a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the organization whose member's permissions to retrieve. |
|
|
The identifier of the team whose members are being listed. |
|
|
Specify the desired response format, such as "application/json". |
|
|
Set the request body media type; not typically needed for GET requests. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Pass additional request options as a JSON object to customize the retrieval. |