Skip to main content
POST
/
core.v1.GroupService
/
ListUserGroupLinks
cURL
curl -X POST "https://api.joinformal.com/core.v1.GroupService/ListUserGroupLinks" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "userGroupLinks": [
    {
      "id": "<string>",
      "group": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "dsyncGroupId": "<string>",
        "terminationProtection": true,
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      },
      "user": {
        "id": "<string>",
        "dbUsername": "<string>",
        "type": "machine",
        "terminationProtection": true,
        "expireAt": "2023-01-15T01:30:15.01Z",
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z",
        "human": {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "jsmith@example.com"
        }
      },
      "terminationProtection": true,
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z"
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal dashboard.

Body

application/json
  • ListUserGroupLinksRequest
  • ListUserGroupLinksRequest
groupId2
string
required
Minimum length: 1
groupId
string
Minimum length: 1
limit
integer
Required range: 0 < x <= 500
cursor
string
order
string

Response

Success

listMetadata
object