Get me partners

  • 1 minute(s) read
Prev Next
Get
/v2/identity/users/me/partners

Returns the list of partners visible by the current user.
Required permissions: READ_PARTNER.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
code
string

Condition on partner code.
For more details on predicates, see the payload common concepts article.

ExampleP000123
name
string

Condition on name property.
For more details on predicates, see the payload common concepts article.

Exampleeq;FooBar
country
string

Condition on country.
For more details on predicates, see the payload common concepts article.

ExampleItaly
PROPERTY_NAME
string

Condition on object property.
For more details on predicates, see the payload common concepts article.

Exampleproperties.propABC=eq;XYZ
size
integer

The number of elements to retrieve for the current page.

Minimum1.0
Example200
page
integer

The page number to retrieve (zero-based).

Minimum0.0
Example0
sort
string

The sorting criteria based on object properties.

Minimum0.0
Examplename,ASC
Responses
200

Successful operation.

Expand All
object
content
Array of object (Partner)
object
id
string
name
string
code
string
country
string
timezone
string
customerCount
number
properties
object (Properties)
Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
organization
object
id
string
Example1234abcd
creationTimestamp
integer (int64)
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error