This endpoint creates or updates an organization:
members
list, the list is treated as exhaustive: all member user IDs must be included, previous members who are not in the list will be removed.HTTP Request
PUT https://api.cord.com/v1/organizations/<ID>
Request Body
Field | Type | Description |
---|---|---|
name |
string |
required on create Organization name |
status |
string |
optional active OR deleted |
members |
(string | number)[] |
optional List of partner-specific IDs of the users who are members of this organization |
Example request:
curl "https://api.cord.com/v1/organizations/456" \
-X PUT \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Planet Express",
"members": ["4", "42"]
}'
If successful, the response will be:
{
"success": true
}
Use this to add and/or remove members from an organization.
Requests to add a user that is already a member of that organisation, or remove a user that is not a member, will have no effect (but will not return an error).
HTTP Request
POST https://api.cord.com/v1/organizations/<ID>/members
Request Body
Field | Type | Description |
---|---|---|
add |
(string | number)[] |
optional List of partner-specific IDs of the users who should be added as members to this organization |
remove |
(string | number)[] |
optional List of partner-specific IDs of the users who should be removed as members from this organization |
Example request to add one member and remove another
curl "https://api.cord.com/v1/organizations/456/members" \
-X POST \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"add": ["4"],
"remove": ["42"]
}'
If successful, the response will be:
{
"success": true
}
This endpoint lists all organizations created in the context of your application.
HTTP Request
GET https://api.cord.com/v1/organizations
Example request to gets the list of organizations:
curl "https://api.cord.com/v1/organizations" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
Example response:
[
{
"id": "10",
"name": "Planet Express"
}
]
HTTP Request
GET https://api.cord.com/v1/organizations/<ID>
Example request to get details for a organization:
curl "https://api.cord.com/v1/organizations/10" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
If the organization exists, the response will be:
{
"id": "10",
"name": "Planet Express",
"members": ["4", "42"]
}