Skip to content

Partnerships API

Partnerships

A partnership object describes a connection between your organization and one of your partner organizations. Partnerships can only be created with partnership invitation (Outgoing invitation) resources.

Attribute Type Editable Description
partner_organization_id UUID read-only ID of the partner organization
partner_organization object read-only The partner organization resource, with all of its available attributes
organization_id UUID read-only ID of your organization, for convenience (matching the <organization_id> in the URL)
organization object read-only Your organization resource, with all of its available attributes
display_name string optional Name that is shown to your organization members for this partner. May be null, in which case the original name is shown
created_at datetime read-only When you became partners

Get a collection of partnerships

Get a paginated collection of all the known partnerships.

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partnerships

This end-point accepts the following GET parameters.

Parameter Type Default Description
ordering ordering created_at Ordering of results with options created_at and -created_at

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization

Retrieve partnership details

Retrieve a single partnership resource for your organization (<organization_id>) by the partner organization's ID (<partner_organization_id>).

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partnerships/<partner_organization_id>

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 404 if partner organization was not found

Remove a partnership

Being aware of this, you may remove another organization (<partner_organization_id>) from your organization's (<organization_id>) partners.

DELETE https://service.giosg.com/api/v5/orgs/<organization_id>/partnerships/<partner_organization_id>

This endpoint returns:

  • 204 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 403 if you do not have settings permission
  • 404 if partner organization was not found

Update a partnership

You may update the editable attributes of a partnership for your organization (<organization_id>) by the given partner organization's ID (<partner_organization_id>).

PUT https://service.giosg.com/api/v5/orgs/<organization_id>/partnerships/<partner_organization_id>

PATCH https://service.giosg.com/api/v5/orgs/<organization_id>/partnerships/<partner_organization_id>

When using PUT you need to provide an object as a request payload that contains the changed attributes of the partnership. When using PATCH, you may omit those attributes that you do not want to change.

This endpoint returns:

  • 200 if the request was successful
  • 400 if required attributes are missing from the request
  • 400 if the request payload is in wrong format
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 403 if you do not have settings permission
  • 404 if partner organization was not found

Partners

A partner object describes a organization resource of your partner organizations. Partners can only be created with partnership invitation (Outgoing invitation) resources.

Attribute Type Editable Description
id UUID read-only ID of the partner organization
name string read-only The name of the partner organization
created_at datetime read-only When the partner organization was created
is_present boolean read-only Whether or not the partner organization is currently present
is_online boolean read-only Whether or not the partner organization is currently online

Get a collection of partners

Get a paginated collection of all the known partners.

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partners

This end-point accepts the following GET parameters.

Parameter Type Default Description
ordering ordering created_at Ordering of results with options created_at and -created_at

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization

Retrieve partner details

Retrieve a single partner resource for your organization (<organization_id>) by the partner organization's ID (<partner_organization_id>).

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partners/<partner_organization_id>

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 404 if partner was not found

Partner's users

A partner user object describes a user resource of your partner organizations.

Attribute Type Editable Description
id UUID read-only ID of the user
full_name string read-only Full name of the user
email string read-only The email of the user
current_chat_count integer read-only The number of chats the user has currently, based on the most recent information about the user
avatar_id UUID read-only ID of the user's avatar
avatar object read-only The avatar of the user as an object. It contains attributes idand url. This is null if the user has no avatar
created_at datetime read-only When the user resource was created
is_present boolean read-only Whether or not the user is currently present
is_online boolean read-only Whether or not the user is currently online

Get a collection of partner's users

Get a paginated collection of all the known users of partner.

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partners/<partner_organization_id>/users

This endpoint takes following GET parameters:

Parameter Type Default Description
ordering ordering created_at Ordering of results with options created_at and -created_at

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 404 if partner organization was not found

Retrieve partner details

Retrieve a single partner user resource of your partner organization (<partner_organization_id>) by the your organization's ID (<organization_id>) and partner organization's user's ID (<user_id>).

GET https://service.giosg.com/api/v5/orgs/<organization_id>/partners/<partner_organization_id>/users/<user_id>

This endpoint returns:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 404 if partner organization was not found