Pricing Templates
Log in Sign up
Integrations / Confluence / ...

GET /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

For example, the following method finds all users that have a 'collaborator' relationship to a piece of content with an ID of '1234': GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user Note, 'collaborator' is an example custom relationship type.

Permissions required: Permission to view both the target entity and source entity.

Servers

Path parameters

Name Type Required Description
targetKey String Yes

The identifier for the target entity:

  • If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the migration guide for details.
  • If targetType is 'content', then specify the content ID.
  • If targetType is 'space', then specify the space key.
targetType String Yes

The target entity type of the relationship.

Possible values:

  • "space"
  • "content"
  • "user"
sourceType String Yes

The source entity type of the relationship.

Possible values:

  • "space"
  • "content"
  • "user"
relationName String Yes

The name of the relationship. This method supports relationships created via Create relationship. Note, this method does not support 'like' or 'favourite' relationships.

Query parameters

Name Type Required Description
limit Integer No

The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

Default value: 25
targetVersion Integer No

The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.
targetStatus String No

The status of the target. This parameter is only used when the targetType is 'content'.
expand[] Array No

A multi-value parameter indicating which properties of the response object to expand.

  • relationData returns information about the relationship, such as who created it and when it was created.
  • source returns the source entity.
  • target returns the target entity.
sourceVersion Integer No

The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.
start Integer No

The starting index of the returned relationships.

Default value: 0
sourceStatus String No

The status of the source. This parameter is only used when the sourceType is 'content'.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy