Skip to main content


Prerequisites #

  • To use the Social Feed API, you must first authenticate yourself and receive a token enables you to access the service. See the Authentication documentation for more information on how to do this.
  • Organization endpoints need a orgId as path parameter.

Requests #

Organization resource provides the following endpoints:

PathHTTP MethodDescription
v1/organizations/{orgId}GETView a specified organization
v1/organizations/{orgId}PUTUpdate an existing organization
v1/organizations/{orgId}DELDelete an existing organization
v1/organizations/{orgId}/personsPOSTCreate a new person of a specified organization

See the API documentation documentation for more information on these endpoints

Example Request #

The following example curl command demonstrates how to view persons of a specified organization.

In a Linux/Unix/macOS environment:

curl -i "<orgId>/persons"
-H "Authorization: Bearer <access_token>"

In Windows PowerShell:


Responses #

  • If successful, the operation responds with HTTP status code 2XX.
  • If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
    • If the authenticating user does not have rights to access the specified organization, the operation returns the Access is denied error.
    • If the authenticating user or the specified organization does not exist, the operation returns the Not found error.
    • If the specified organization is already exist, the operation returns the Conflict error.
    • If the Authorization header is not present or invalid, a 401 error code will be returned.