Skip to main content
GET
/
party-groups
/
{groupId}
Retrieve a party group
curl --request GET \
  --url https://sandbox-api.finpace.example/v1/party-groups/{groupId} \
  --header 'Authorization: Bearer <token>'
{
  "groupId": "grp_01JQ9KDN2S9YB2X6K11H65VF0K",
  "name": "Northwind Group",
  "members": [
    {
      "partyId": "<string>",
      "relationshipType": "subsidiary",
      "ownershipPercentage": 100
    }
  ]
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 with client credentials for machine integrations and authorization code for delegated user sessions.

Headers

​
X-Request-Id
string

Caller-generated correlation identifier used for tracing.

Maximum string length: 80

Path Parameters

​
groupId
string
required

Response

Party group returned

​
groupId
string
required
Example:

"grp_01JQ9KDN2S9YB2X6K11H65VF0K"

​
name
string
required
Example:

"Northwind Group"

​
members
object[]
required