Skip to main content
GET
/
v1
/
internal-parties
List Internal Parties
curl --request GET \
  --url https://live.copilot.fabric.inc/data-customer/v1/internal-parties \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "offset": 0,
    "limit": 10,
    "count": 56
  },
  "data": [
    {
      "_id": "61df41892bf06d00092d0d8a",
      "parentInternalPartyId": "61df41892bf06d00092d0d8f",
      "employeeIdentifier": "employee_123",
      "name": "INTERNAL PARTY Section 1",
      "internalPartyType": "O",
      "isActive": true,
      "email": "org@gmail.com",
      "additionalAttributes": {},
      "isDeleted": false,
      "createdAt": "2021-08-30T23:20:42.822Z",
      "updatedAt": "2021-08-30T23:20:42.822Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-site-context
string
required
Example:

Query Parameters

​
offset
integer
Example:
​
limit
integer
Example:
​
sortOrder
enum<string>
Available options:
asc,
desc
Example:
​
sortBy
enum<string>
Available options:
updatedAt,
name,
email,
isActive,
internalPartyType
Example:
​
id
string
Example:
​
internalPartyType
enum<string>
Available options:
O,
H,
P,
C
Example:
​
name
string
Example:
​
isActive
boolean
Example:
​
filterBy
string
Example:
​
filterField
string
Example:
​
filterValue
string
Example:

Response

​
query
object
​
data
InternalPartyResponse · object[]