Organization Group Members
List all group members
This endpoint allows you to retrieve a list of all members in an organization group.
The default behavior is to exclude inactive and expired members.
The org parameter is the organization identifier (ask your account manager for the organization identifier).
The group parameter would be the code of the group, e.g. gold, silver, bronze, youth, etc.
Optional attributes
- Name
include_meta- Type
- boolean
- Description
Include additional metadata about the members. Defaults to false.
- Name
exclude_inactive- Type
- boolean
- Description
Exclude inactive members from the results. Defaults to true.
- Name
exclude_expired- Type
- boolean
- Description
Exclude expired members from the results. Defaults to true.
Request
curl -G https://public-api.dartconnect.com/api/v1/org-groups/{group}/members \
-H "Authorization: Bearer {token}" \
-d include_meta=true \
-d exclude_inactive=false \
-d exclude_expired=false
Response
{
"data": [
{
"org_group": "gold",
"email": "member@example.com",
"phone": "+1234567890",
"seed": 12,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"third_party_id": "cust_123456",
"gender": "M",
"dob": "1980-03-14",
"is_youth": true,
"is_active": true,
"start_date": "2025-04-09",
"end_date": null,
"created_at": "2024-03-19T12:00:00Z",
"updated_at": "2024-03-19T12:00:00Z",
"meta": {
// Meta information when include_meta is true
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "Springfield",
"region": "IL",
"postal": "62701",
"iso2_country": "US",
"iso3_country": "USA",
"cellphone": "+1-234-567-8900"
}
}
// ... more members
]
}
Create a group member
This endpoint allows you to add a new member to an organization group.
The org parameter is the organization identifier (ask your account manager for the organization identifier).
The group parameter is the code of the group (e.g., 'gold', 'silver', 'bronze', 'youth').
Required attributes
- Name
email- Type
- string
- Description
Email address of the member.
Optional attributes
- Name
first_name- Type
- string
- Description
First name of the member.
- Name
last_name- Type
- string
- Description
Last name of the member.
- Name
phone- Type
- string
- Description
Phone number of the member. Should include country code (e.g., '+1-234-567-8900').
- Name
seed- Type
- integer
- Description
Seed value for the member.
- Name
full_name- Type
- string
- Description
Full name of the member. Auto-generated if not provided.
- Name
third_party_id- Type
- string
- Description
A system identifier you can use for the member, like your internal member ID.
- Name
start_date- Type
- date
- Description
Start date for the membership. Defaults to NULL.
- Name
end_date- Type
- date
- Description
End date for the membership. Must be after or equal to start_date.
- Name
is_active- Type
- boolean
- Description
Whether the member is active.
- Name
update_existing- Type
- boolean
- Description
If true, updates the member's information when they already exist. Otherwise, a 409 error is returned.
Request
curl -X POST https://public-api.dartconnect.com/api/v1/orgs/{org}/groups/{group}/members \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"email": "member@example.com", // the only required field
"third_party_id": "1234567890", // your internal member ID
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe", // auto-generated if not provided
"gender": "M", // M or F
"dob": "1980-03-30", // date of birth
"phone": "+1-234-567-8900", // phone number with country code
"seed": 52, // optional seed value if maintaining seed records
"is_youth": true, // optional way to identify youth members
"is_active": true, // optional way to enable/disable member
"start_date": "2027-03-19", // when membership starts
"end_date": "2028-03-19" // when membership ends
}'
Response
{
"data": {
"email": "member@example.com",
"org_group": "gold",
"phone": "+1-234-567-8900",
"seed": 52,
"third_party_id": "1234567890", // your internal member ID
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"gender": "M",
"dob": "1980-03-30",
"start_date": "2027-03-19",
"end_date": "2028-03-19",
"is_youth": true,
"is_active": true
}
}
Delete a group member
This endpoint allows you to delete a member from an organization group.
The org parameter is the organization identifier (ask your account manager for the organization identifier).
The group parameter is the code of the group (e.g., 'gold', 'silver', 'bronze', 'youth').
Required attributes
- Name
email- Type
- string
- Description
Email address of the member to delete.
Request
curl -X DELETE https://public-api.dartconnect.com/api/v1/orgs/{org}/groups/{group}/members \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{ "email": "member@example.com" }'
Response
{
"data": {
"group": "gold",
"email": "member@example.com"
}
}
Response codes
- Name
200- Description
Member was successfully created, updated, or deleted.
- Name
400- Description
Invalid request parameters.
- Name
401- Description
Invalid or missing authentication token.
- Name
403- Description
Insufficient permissions to manage members in this group.
- Name
404- Description
Member not found (for DELETE operations).
- Name
409- Description
Member already exists (for POST operations when update_existing is false).