{ "opencollection": "1.0.0", "info": { "name": "Capmo REST Organisation Companies Organisation Memberships API", "version": "1.0" }, "items": [ { "info": { "name": "Organisation Memberships", "type": "folder" }, "items": [ { "info": { "name": "getOrganisationMemberships", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/organisation/memberships", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Field to order by. It can be any field of the entity." }, { "name": "order_direction", "value": "", "type": "query", "description": "Order direction of the `order_by` field. It can be `asc` or `desc`." }, { "name": "after", "value": "", "type": "query", "description": "The last element from the previous page. This is a cursor. It will be returned in the output to be used in the next request. When it is not present, the first page is returned. When it is `null`, there are no more pages." }, { "name": "limit", "value": "", "type": "query", "description": "How many items should be in the output." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to list all organisation memberships in a paginated response." }, { "info": { "name": "inviteOrganisationPerson", "type": "http" }, "http": { "method": "POST", "url": "https://api.capmo.de/api/v1/organisation/memberships", "headers": [ { "name": "Request-Id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to invite an organisation contact book person to organisation. As a result, an organisation membership for them will be created." }, { "info": { "name": "getOrganisationMembership", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/organisation/memberships/:membershipId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to retrieve a specific organisation membership by its ID." }, { "info": { "name": "updateOrganisationMembership", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.capmo.de/api/v1/organisation/memberships/:membershipId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to update an organisation membership." }, { "info": { "name": "revokeOrganisationMembership", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.capmo.de/api/v1/organisation/memberships/:membershipId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to revoke an organisation membership." } ] } ], "bundled": true }