Skip to main content

​
List Parties

Retrieves a list of all parties within an organization. 
GET /v1/organizations/:orgId/parties

​
Path Parameters

ParameterTypeRequiredDescription
orgIdstringRequiredOrganization ID (prefix: org_)

​
Query Parameters

ParameterTypeDefaultDescription
limitinteger20Maximum items to return (max 100)
offsetinteger0Number of items to skip
typestring-Filter by type: INDIVIDUAL or ORGANIZATION
searchstring-Filter by name (partial match)

​
Example Request

# List all parties
curl https://api.docyard.io/v1/organizations/org_01HQ3K.../parties \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

# Filter by type
curl "https://api.docyard.io/v1/organizations/org_01HQ3K.../parties?type=ORGANIZATION" \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

# Search by name
curl "https://api.docyard.io/v1/organizations/org_01HQ3K.../parties?search=First American" \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

# Paginate
curl "https://api.docyard.io/v1/organizations/org_01HQ3K.../parties?limit=10&offset=20" \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

​
Response

{
  "data": [
    {
      "id": "pty_01HQ3K9B2...",
      "organizationId": "org_01HQ3K9...",
      "type": "ORGANIZATION",
      "name": "First American Title Insurance",
      "email": "[email protected]",
      "externalRef": "EIN:94-1234567",
      "metadata": {
        "naic": "12345"
      },
      "createdAt": "2024-03-01T12:00:00.000Z",
      "updatedAt": "2024-03-01T12:00:00.000Z"
    },
    {
      "id": "pty_01HQ3L9C3...",
      "organizationId": "org_01HQ3K9...",
      "type": "ORGANIZATION",
      "name": "Wells Fargo Mortgage",
      "email": "[email protected]",
      "externalRef": "EIN:94-7654321",
      "metadata": {
        "nmlsId": "1234"
      },
      "createdAt": "2024-02-15T09:30:00.000Z",
      "updatedAt": "2024-02-15T09:30:00.000Z"
    }
  ],
  "meta": {
    "total": 45,
    "page": 1,
    "pageSize": 20,
    "hasMore": true
  }
}

​
Response Fields

FieldTypeDescription
dataarrayList of party objects
data[].idstringParty identifier (prefix: pty_)
data[].typestringINDIVIDUAL or ORGANIZATION
data[].namestringParty display name
data[].emailstringPrimary contact email
data[].externalRefstringExternal identifier
data[].metadataobjectCustom attributes
meta.totalintegerTotal parties matching query
meta.pageintegerCurrent page number
meta.hasMorebooleanWhether more results exist

​
Error Handling

StatusCondition
401Missing or invalid API key
404Organization not found

​
Use Cases

Directory View: Display all counterparties for relationship management. Type Filtering: Show only institutional parties (ORGANIZATION) or individual participants (INDIVIDUAL). Search: Quickly find parties by partial name matching.