Connect API

What is Symphony Connect?

Symphony Connect allows Symphony partners to enable the users of their applications to collaborate on Symphony, by adding those companies and users to the Symphony network.

Users can leverage the Symphony Embedded Collaboration Platform (ECP) in order to chat from within the partner application.

Partners can use the Connect APIs to create accounts on Symphony for their application users, if they do not already belong to the Symphony network.

If a user’s company is not yet available on Symphony, a dedicated Symphony tenant can be created for that company before onboarding its users.

Prerequisites

Before they can use Connect APIs to add client companies, as well as add or disable users, partners must register with Symphony. Following registration, partners receive credentials to authenticate to these APIs.

If they want to offer a seamless login experience to Symphony, partners need to provide Symphony with their Identity Provider details. The recommended authentication method is SAML, although other authentication methods are also available (additional charges apply).

If you would like to register as a Symphony partner, create new users and embed Symphony within your application, please contact us.

Domains

In order to target the different APIs described below, the user should use the correct domain, depending on their environment:

• PROD: https://community.symphony.com/api

• UAT: https://community.uat.symphony.com/api

Authentication

To be able to call this API, you first need to get an access token.

curl --request POST \
  --url https://us-auth.prod.symphony.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"$client_id","client_secret":"$client_secret","audience":"https://api.symphony.com/partners","grant_type":"client_credentials"}'

To get your client_id and your client_secret, please contact Symphony.

In the response, you should get:

{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkthaFZHSlZUOFRuSWNRamNrTW1FcSJ9.eyJodHRwczovL2F1dGguc3ltcGhvbnkuY29tL3BhcnRuZXJfaWQiOiJ5b3VyX3BhcnRuZXIiLCJpc3MiOiJodHRwczovL2Rldi13NHRlc2NvZS51cy5hdXRoMC5jb20vIiwic3ViIjoiS0pCSkpMdnd4ZkllZ0NRdjBCNm5lcGxZN25rYVNOam9AY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYXBpLnN5bXBob255LmNvbS9wYXJ0bmVycyIsImlhdCI6MTY1NDI2MzMxMCwiZXhwIjoxNjU0MzQ5NzEwLCJhenAiOiJLSkJKSkx2d3hmSWVnQ1F2MEI2bmVwbFk3bmthU05qbyIsInNjb3BlIjoiY29tbXVuaXR5OmFjY291bnRzOm9uYm9hcmQiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMifQ.BN5iW4sXeo4B3ecp0u3fj--tYhsVTZOWi_UgaPvHdS4PI2uopT-XfcBLCIb1PIXogshy8ZAQkwwQpiroBd9rcJDHW-ERsCWCsc6ruZKIHmvslAVF7AoLNN_GbqvvTgKLqbfTqdgNcyCg27oem6il8NhQDO0mu9ndOsJtdmwQ7Tczkla8uBoHiEO7_p1F17njxQYxpXbmG2Tfe_SUUmS0ec5vbV2-btKet3uMm5J8E8mockr8VrXLcu5hNxishELrQ6uCgmreit8R4EZNVIwK43CRnibCV7F8MQpiTkNJMYnVybwdqNOZFBzcuXRQIQHEmiW41xILuXOdPowCvBAS7w",
"token_type": "Bearer"
}

You can now use the access_tokento make authorized calls to the API. You should pass it as a Bearer token in the Authorization header.

Create company

A Connect partner can use this endpoint to sponsor a new company in Symphony.

As input, the partner must provide:

• A name: The company name that will be visible in the user’s profile in the Directory and can be used during user search.

• A vanityName: This will be used to construct the tenant publicUrl under which the user Symphony session will be launched. For example, if the vanity name is “coke”, the URL will be https://coke.on.symphony.com.

• emailDomains: The list of email domains used by the users in that company. Only users with email addresses belonging to those domains can be added later on. To update the domain list, please contact your Symphony representative.

REST call to create a company:

curl -X 'POST' \
  'https://community.symphony.com/api/v2/companies' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
  "name": "Lyondell",
  "vanityName": "lyondell",
  "emailDomains": [
    "lyondell.com"
  ]
}'

Response you should get:

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "name": "Lyondell",
  "vanityName": "lyondell",
  "emailDomains": [
    "lyondell.com"
  ],
  "publicUrl": "https://lyondell.on.symphony.com",
  "state": "STARTED"
}

Success

If successful, a dedicated Symphony tenant will be created for that company and will become accessible under the tenant publicUrl derived from the vanityName field.

If a user leverages the Symphony channels (Web, Desktop, Mobile), they will need to log in by accessing the tenant publicURL directly in the browser, desktop or mobile application.

If a user leverages ECP, the partner needs to load ECP using that tenant publicUrl.

Failure

Company creation will fail in the following cases:

• There is already a company in the Directory with users having email addresses with domains belonging to the provided list of email domains.

• There is already a company in the Directory with the same company name.

• There is already a company in the Directory with the same vanityName.

• If the conflicting company has been onboarded by the same partner and the list of email domains is different, an error will be thrown. In that case, the partner needs to amend the list of email domains for the company before adding users.

In case of failures, to verify whether the users of that company already have a Symphony account or not, you can call the following endpoint: https://loginservice.symphony.com/webcontroller/podLoginInformation?emailAddress={%email%}&fs=advanced

*where {%email%} needs to be replaced by the user’s email address.

If users do not have an account, you are encouraged to reach out to [e-mail] or to your Symphony representative so they can help you onboard the users.

Create company

The creation of a company in Symphony is done in asynchronously in the background. When this call returns the state of the company will be STARTED. Please allow approximately 20 min for the company to be fully provisioned. To verify the current status of the company you can poll the 'retrieve company' endpoint using the returned id.

POSThttps://community.uat.symphony.com/api/v2/companies

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

name*string

Name of the company

Example: "Lyondell"

vanityName*string

Vanity name of the company will generate the public url of the tenant

Example: "lyondell"

Pattern: [a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?

emailDomains*array of string

List of email domains with which users can be registered to the tenant

publicUrlstring

The Symphony public url of the company

Example: "https://lyondell.on.symphony.com"

stateenum

The state of the company to indicate if the creation is completed

Example: "STARTED"

STARTEDTENANT_CREATEDTENANT_CREATION_ERRORAUTH0_CONFIG_ERRORTENANT_CONFIG_ERRORCOMPLETED

errorMessagestring

Message providing additional information about the company creation error

Example: "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"

Response

202

Accepted

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

name*string

Name of the company

Example: "Lyondell"

vanityName*string

Vanity name of the company will generate the public url of the tenant

Example: "lyondell"

Pattern: [a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?

emailDomains*array of string

List of email domains with which users can be registered to the tenant

publicUrlstring

The Symphony public url of the company

Example: "https://lyondell.on.symphony.com"

stateenum

The state of the company to indicate if the creation is completed

Example: "STARTED"

STARTEDTENANT_CREATEDTENANT_CREATION_ERRORAUTH0_CONFIG_ERRORTENANT_CONFIG_ERRORCOMPLETED

errorMessagestring

Message providing additional information about the company creation error

Example: "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emailDomains": [
        "lyondell.com"
      ],
      "name": "Lyondell",
      "vanityName": "lyondell"
    }),
});
const data = await response.json();

Response

202

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "name": "Lyondell",
  "vanityName": "lyondell",
  "emailDomains": [
    "lyondell.com"
  ],
  "publicUrl": "https://lyondell.on.symphony.com",
  "state": "STARTED",
  "errorMessage": "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"
}

Create users

A Connect partner can use this endpoint to provision new users in Symphony under an existing sponsored company.

As input, the partner must provide:

• A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.

• An array of user information (in the body of the request). It is recommended to provide a maximum of information in order to facilitate user search in the Directory.

REST call to create users:

curl -X 'POST' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0/users' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '[
  {
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Smith",
    "displayName": "John Smith",
    "active": false,
    "phoneNumber": "true",
    "department": "Order Processing",
    "title": "Mr.",
    "location": "Sophia Antipolis"
  }
]'

Response you should get:

[
  {
    "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
    "createdAt": "2023-12-22T08:53:39.269539Z",
    "updatedAt": "2023-12-20T10:59:54.516494Z",
    "symphonyUserId": 695234946138125,
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Smith",
    "displayName": "John Smith",
    "active": true,
    "phoneNumber": "[phone]",
    "department": "Order Processing",
    "title": "Mr.",
    "location": "Sophia Antipolis",
    "status": 201
  }
]

Create users

Create users in a given company. Up to 20 users can be created in one API call.

POSThttps://community.uat.symphony.com/api/v2/companies/{companyId}/users

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

symphonyUserIdinteger (int64)

Symphony user id

Example: 691867691778058

statusinteger (int32)

Individual http status code

Example: 201

errorProblemDetail (object)

Detailed error information

email*string

User's email address

Example: "[e-mail]"

firstName*string

User's first name

Example: "John"

lastName*string

User's last name

Example: "Smith"

displayNamestring

User's display name, if not provided it is a concatenation of the first name and the last name

Example: "John Smith"

activeboolean

User's phone number

Example: false

phoneNumberstring

User's status on Symphony

Example: "true"

departmentstring

User's department

Example: "Order Processing"

titlestring

User's title

Example: "Mr."

locationstring

User's location

Example: "Sophia Antipolis"

Response

201207400

All users are successfully created.

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

symphonyUserIdinteger (int64)

Symphony user id

Example: 691867691778058

statusinteger (int32)

Individual http status code

Example: 201

errorProblemDetail (object)

Detailed error information

email*string

User's email address

Example: "[e-mail]"

firstName*string

User's first name

Example: "John"

lastName*string

User's last name

Example: "Smith"

displayNamestring

User's display name, if not provided it is a concatenation of the first name and the last name

Example: "John Smith"

activeboolean

User's phone number

Example: false

phoneNumberstring

User's status on Symphony

Example: "true"

departmentstring

User's department

Example: "Order Processing"

titlestring

User's title

Example: "Mr."

locationstring

User's location

Example: "Sophia Antipolis"

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Smith"
      }
    ]),
});
const data = await response.json();

Response

201207400

[
  {
    "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
    "createdAt": "2023-12-22T08:53:39.269539Z",
    "updatedAt": "2023-12-20T10:59:54.516494Z",
    "symphonyUserId": 691867691778058,
    "status": 201,
    "error": {
      "type": "https://example.com",
      "title": "text",
      "status": 0,
      "detail": "text",
      "instance": "https://example.com"
    },
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Smith",
    "displayName": "John Smith",
    "active": false,
    "phoneNumber": "true",
    "department": "Order Processing",
    "title": "Mr.",
    "location": "Sophia Antipolis"
  }
]

Update user status

A Connect partner can use this endpoint to disable or re-enable a user.

As input, the partner must provide:

• A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.

• A userId (as a query parameter of the request): The userId can be obtained by calling the Get company users API.

• A user active status indicator (in the body of request).

Once disabled, the user is no longer associated with the partner, and can no longer log in to Symphony. The user’s chats, however, are kept in order to meet any compliance requirements.

REST call to disable a user:

curl -X 'PATCH' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0/users/5bec2e8b-da45-46c7-9370-5669de1b1a78' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
  "active": false
}'

Update user status

Enable or disable a specific user account.

PATCHhttps://community.uat.symphony.com/api/v2/companies/{companyId}/users/{userId}

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

userId*string

Id of the user

Example: "5bec2e8b-da45-46c7-9370-5669de1b1a78"

Body

application/json

active*boolean

Active

Response

200404

User status successfully updated

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}/users/{userId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false
    }),
});
const data = await response.json();

Response

404

{
  "type": "https://example.com",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "https://example.com"
}

Search companies

A Connect partner can use this endpoint to retrieve the list of companies it has sponsored.

curl -X 'GET' \
  'https://community.symphony.com/api/v2/companies' \
  -H 'accept: application/json'
  -H 'Authorization: Bearer {access_token}' 

Response you should get:

[
  {
    "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
    "createdAt": "2023-12-22T08:53:39.269539Z",
    "updatedAt": "2023-12-20T10:59:54.516494Z",
    "name": "Lyondell",
    "vanityName": "lyondell",
    "emailDomains": [
      "lyondell.com"
    ],
    "publicUrl": "https://lyondell.on.symphony.com",
    "state": "COMPLETED"
  }
]

Search companies

Retrieve a company or the complete list of companies.

If the 'vanityName' is passed as a query parameter the company matching this name is returned.

If no query parameter is passed, the complete list of companies is returned.

GEThttps://community.uat.symphony.com/api/v2/companies

Query parameters

Response

200

OK

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

name*string

Name of the company

Example: "Lyondell"

vanityName*string

Vanity name of the company will generate the public url of the tenant

Example: "lyondell"

Pattern: [a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?

emailDomains*array of string

List of email domains with which users can be registered to the tenant

publicUrlstring

The Symphony public url of the company

Example: "https://lyondell.on.symphony.com"

stateenum

The state of the company to indicate if the creation is completed

Example: "STARTED"

STARTEDTENANT_CREATEDTENANT_CREATION_ERRORAUTH0_CONFIG_ERRORTENANT_CONFIG_ERRORCOMPLETED

errorMessagestring

Message providing additional information about the company creation error

Example: "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
    "createdAt": "2023-12-22T08:53:39.269539Z",
    "updatedAt": "2023-12-20T10:59:54.516494Z",
    "name": "Lyondell",
    "vanityName": "lyondell",
    "emailDomains": [
      "lyondell.com"
    ],
    "publicUrl": "https://lyondell.on.symphony.com",
    "state": "STARTED",
    "errorMessage": "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"
  }
]

Retrieve company

A Connect partner can use this endpoint to retrieve a sponsored company’s information.

As input, the partner must provide:

• A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.

curl -X 'GET' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0' \
  -H 'accept: application/json'
  -H 'Authorization: Bearer {access_token}'

Response you should get:

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "name": "Lyondell",
  "vanityName": "lyondell",
  "emailDomains": [
    "lyondell.com"
  ],
  "publicUrl": "https://lyondell.on.symphony.com",
  "state": "COMPLETED"
}

Retrieve company

Retrieve the details of a company, including the creation status.

When the status is COMPLETED the company is ready to be used, and users can be created on it.

If the state is not STARTED or COMPLETED, please contact Symphony for support.

GEThttps://community.uat.symphony.com/api/v2/companies/{companyId}

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

Response

200

OK

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

name*string

Name of the company

Example: "Lyondell"

vanityName*string

Vanity name of the company will generate the public url of the tenant

Example: "lyondell"

Pattern: [a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?

emailDomains*array of string

List of email domains with which users can be registered to the tenant

publicUrlstring

The Symphony public url of the company

Example: "https://lyondell.on.symphony.com"

stateenum

The state of the company to indicate if the creation is completed

Example: "STARTED"

STARTEDTENANT_CREATEDTENANT_CREATION_ERRORAUTH0_CONFIG_ERRORTENANT_CONFIG_ERRORCOMPLETED

errorMessagestring

Message providing additional information about the company creation error

Example: "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "name": "Lyondell",
  "vanityName": "lyondell",
  "emailDomains": [
    "lyondell.com"
  ],
  "publicUrl": "https://lyondell.on.symphony.com",
  "state": "STARTED",
  "errorMessage": "Please contact Symphony support by providing the X-Trace-Id = KUfkYm"
}

Update company

A Connect partner can use this endpoint to add new email domains to an existing company.

curl -X 'PATCH' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'
  -d '{
  "emailDomains": [
    "lyondell.com"
  ]
}'

Success

In response you should get code HTTP 200.

Failure

When there already is a company in the Directory with users who have email addresses with domains belonging to the provided list of email domains.

Update company

Update company to add additional email domains.

PATCHhttps://community.uat.symphony.com/api/v2/companies/{companyId}

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

Body

application/json

emailDomains*array of string

List of email domains with which users can be registered to the tenant

Response

200304404

Company email domains successfully updated

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emailDomains": [
        "lyondell.com"
      ]
    }),
});
const data = await response.json();

Response

404

{
  "type": "https://example.com",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "https://example.com"
}

Retrieve company users

A Connect partner can use this endpoint to retrieve the list of users of a company it has sponsored.

As input, the partner must provide:

• A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.

The users are returned in paging mode. If the company has large number of users, multiple API calls need to be made to retrieve the full list of users. To retrieve the users on different pages, the partner must provide:

• A currentPage (as a query parameter of the request): This is the page number. To see the total number of pages, partners can make a REST call such as the one below.

• A pageSize (as a query parameter of the request): To specify how many users to be displayed on the page.

REST call to retrieve the list of users:

curl -X 'GET' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0/users' \
  -H 'accept: application/json'
  -H 'Authorization: Bearer {access_token}'

In response, you should get the paging information (total number of users, current page and page size), and a list of users as below:

{
  "total": 150,
  "pageSize": 100,
  "currentPage": 1,
  "users": [
    {
      "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
      "createdAt": "2023-12-22T08:53:39.269539Z",
      "updatedAt": "2023-12-20T10:59:54.516494Z",
      "symphonyUserId": 691867691778058,
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Smith",
      "displayName": "John Smith",
      "phoneNumber": "[phone]",
      "department": "Order Processing",
      "title": "Mr.",
      "location": "Sophia Antipolis"
    },
    ...
  ]
}

Retrieve company users

Retrieves users of a given company. Results are paginated by user creation date.

An initial query should be done without specifying any paging query parameters to retrieve the total number of rows.

Page size is configurable, with a maximum size of 100 users.

GEThttps://community.uat.symphony.com/api/v2/companies/{companyId}/users

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

Query parameters

Response

200400

OK

Body

application/json

totalinteger (int64)

Total number of record

Example: 300

pageSizeinteger (int32)

Number of records records returned on one page

Example: 20

currentPageinteger (int32)

The current page number, starting from zero

Example: 0

usersarray of User (object)

Collection of users

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "total": 300,
  "pageSize": 20,
  "currentPage": 0,
  "users": [
    {
      "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
      "createdAt": "2023-12-22T08:53:39.269539Z",
      "updatedAt": "2023-12-20T10:59:54.516494Z",
      "symphonyUserId": 691867691778058,
      "status": 201,
      "error": {
        "type": "https://example.com",
        "title": "text",
        "status": 0,
        "detail": "text",
        "instance": "https://example.com"
      },
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Smith",
      "displayName": "John Smith",
      "active": false,
      "phoneNumber": "true",
      "department": "Order Processing",
      "title": "Mr.",
      "location": "Sophia Antipolis"
    }
  ]
}

Retrieve user

A Connect partner can use this endpoint to retrieve the detail of a single user of a company it has sponsored.

As input, the partner must provide:

• A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.

• A userId (as a query parameter of the request): The userId can be obtained by calling the Get company users API.

curl -X 'GET' \
  'https://community.symphony.com/api/v2/companies/e176c55e-6e49-4819-b982-12e0535db5f0/users/5bec2e8b-da45-46c7-9370-5669de1b1a78' \
  -H 'accept: application/json'
  -H 'Authorization: Bearer {access_token}'

In response you should get:

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "symphonyUserId": 695234946138125,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Smith",
  "displayName": "John Smith",
  "active": true,
  "phoneNumber": "[phone]",
  "department": "Order Processing",
  "title": "Mr.",
  "location": "Sophia Antipolis",
  "status": 201
}

Retrieve user

Retrieves a user of a given company by providing the user id.

GEThttps://community.uat.symphony.com/api/v2/companies/{companyId}/users/{userId}

Path parameters

companyId*string

Id of the company

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

userId*string

Id of the user

Example: "5bec2e8b-da45-46c7-9370-5669de1b1a78"

Response

200404

OK

Body

application/json

idstring

Unique identifier

Example: "e176c55e-6e49-4819-b982-12e0535db5f0"

createdAtstring (date-time)

Creation date

Example: "2023-12-22T08:53:39.269539Z"

updatedAtstring (date-time)

Last update date

Example: "2023-12-20T10:59:54.516494Z"

symphonyUserIdinteger (int64)

Symphony user id

Example: 691867691778058

statusinteger (int32)

Individual http status code

Example: 201

errorProblemDetail (object)

Detailed error information

email*string

User's email address

Example: "[e-mail]"

firstName*string

User's first name

Example: "John"

lastName*string

User's last name

Example: "Smith"

displayNamestring

User's display name, if not provided it is a concatenation of the first name and the last name

Example: "John Smith"

activeboolean

User's phone number

Example: false

phoneNumberstring

User's status on Symphony

Example: "true"

departmentstring

User's department

Example: "Order Processing"

titlestring

User's title

Example: "Mr."

locationstring

User's location

Example: "Sophia Antipolis"

Request

JavaScriptCurlPython

const response = await fetch('https://community.uat.symphony.com/api/v2/companies/{companyId}/users/{userId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "e176c55e-6e49-4819-b982-12e0535db5f0",
  "createdAt": "2023-12-22T08:53:39.269539Z",
  "updatedAt": "2023-12-20T10:59:54.516494Z",
  "symphonyUserId": 691867691778058,
  "status": 201,
  "error": {
    "type": "https://example.com",
    "title": "text",
    "status": 0,
    "detail": "text",
    "instance": "https://example.com"
  },
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Smith",
  "displayName": "John Smith",
  "active": false,
  "phoneNumber": "true",
  "department": "Order Processing",
  "title": "Mr.",
  "location": "Sophia Antipolis"
}